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
@@ -62,6 +62,8 @@ module Wx::HTML
62
62
  # Helper class for {Wx::HTML::HtmlHelpData}.
63
63
  #
64
64
  #
65
+ #
66
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
65
67
  class HtmlBookRecord < ::Object
66
68
 
67
69
  # @param bookfile [String]
@@ -125,6 +127,8 @@ module Wx::HTML
125
127
  # Helper class for {Wx::HTML::HtmlHelpData}.
126
128
  #
127
129
  #
130
+ #
131
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
128
132
  class HtmlHelpDataItem < ::Object
129
133
 
130
134
  # @return [HtmlHelpDataItem]
@@ -108,7 +108,7 @@ module Wx::HTML
108
108
 
109
109
  # This class is used by {Wx::HTML::HtmlHelpController} to display help within a frame or dialog, but you can use it yourself to create an embedded HTML help window.
110
110
  # For example:
111
- #
111
+ # ```
112
112
  # // m_embeddedHelpWindow is a wxHtmlHelpWindow
113
113
  # // m_embeddedHtmlHelp is a wxHtmlHelpController
114
114
  #
@@ -119,6 +119,7 @@ module Wx::HTML
119
119
  # m_embeddedHelpWindow->Create(this, wxID_ANY, wxDefaultPosition, GetClientSize(),
120
120
  # wxTAB_TRAVERSAL|wxBORDER_NONE, wxHF_DEFAULT_STYLE);
121
121
  # m_embeddedHtmlHelp.AddBook(wxFileName(wxT("doc.zip")));
122
+ # ```
122
123
  #
123
124
  # You should pass the style {Wx::HTML::HF_EMBEDDED} to the style parameter of {Wx::HTML::HtmlHelpController} to allow the embedded window to be destroyed independently of the help controller.
124
125
  # ===
@@ -56,6 +56,46 @@ module Wx::HTML
56
56
  # @return [true,false]
57
57
  def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::HtmlListBoxNameStr) end
58
58
 
59
+
60
+ protected
61
+
62
+ # Called when the user clicks on hypertext link.
63
+ # Does nothing by default. Overloading this method is deprecated; intercept the event instead.
64
+ # @see Wx::HTML::HtmlLinkInfo.
65
+ # @param n [Integer] Index of the item containing the link.
66
+ # @param link [Wx::HtmlLinkInfo] Description of the link.
67
+ # @return [void]
68
+ def on_link_clicked(n, link) end
69
+
70
+ # This virtual function may be overridden to change the appearance of the background of the selected cells in the same way as {Wx::HTML::HtmlListBox#get_selected_text_colour}.
71
+ # It should be rarely, if ever, used because {Wx::VListBox#set_selection_background} allows changing the selection background for all cells at once and doing anything more fancy is probably going to look strangely.
72
+ # @see Wx::HTML::HtmlListBox#get_selected_text_colour
73
+ # @param colBg [Wx::Colour,String,Symbol]
74
+ # @return [Wx::Colour]
75
+ def get_selected_text_bg_colour(colBg) end
76
+ alias_method :selected_text_bg_colour, :get_selected_text_bg_colour
77
+
78
+ # This virtual function may be overridden to customize the appearance of the selected cells.
79
+ # It is used to determine how the colour colFg is going to look inside selection. By default all original colours are completely ignored and the standard, system-dependent, selection colour is used but the program may wish to override this to achieve some custom appearance.
80
+ # @see Wx::HTML::HtmlListBox#get_selected_text_bg_colour
81
+ # @see Wx::VListBox#set_selection_background
82
+ # @see Wx::SystemSettings.get_colour
83
+ # @param colFg [Wx::Colour,String,Symbol]
84
+ # @return [Wx::Colour]
85
+ def get_selected_text_colour(colFg) end
86
+ alias_method :selected_text_colour, :get_selected_text_colour
87
+
88
+ # This function may be overridden to decorate HTML returned by {Wx::HTML::HtmlListBox#on_get_item}.
89
+ # @param n [Integer]
90
+ # @return [String]
91
+ def on_get_item_markup(n) end
92
+
93
+ # This method must be implemented in the derived class and should return the body (i.e. without html nor body tags) of the HTML fragment for the given item.
94
+ # Note that this function should always return a text fragment for the n item which renders with the same height both when it is selected and when it's not: i.e. if you call, inside your {Wx::HTML::HtmlListBox#on_get_item} implementation, <code>IsSelected(n)</code> to make the items appear differently when they are selected, then you should make sure that the returned HTML fragment will render with the same height or else you'll see some artifacts when the user selects an item.
95
+ # @param n [Integer]
96
+ # @return [String]
97
+ def on_get_item(n) end
98
+
59
99
  end # HtmlListBox
60
100
 
61
101
  # {Wx::HTML::SimpleHtmlListBox} is an implementation of {Wx::HTML::HtmlListBox} which shows HTML content in the listbox rows.
@@ -117,17 +157,6 @@ module Wx::HTML
117
157
  # @return [true,false]
118
158
  def create(*args) end
119
159
 
120
- # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=Wx::HTML::HLB_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SimpleHtmlListBoxNameStr)
121
- # Constructor, creating and showing the HTML list box.
122
- # @param parent [Wx::Window] Parent window. Must not be NULL.
123
- # @param id [Integer] Window identifier. A value of -1 indicates a default value.
124
- # @param pos [Array(Integer, Integer), Wx::Point] Window position. If {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
125
- # @param size [Array(Integer, Integer), Wx::Size] Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
126
- # @param choices [Array<String>] An array of strings with which to initialise the control.
127
- # @param style [Integer] Window style. See {Wx::HLB_}* flags.
128
- # @param validator [Wx::Validator] Window validator.
129
- # @param name [String] Window name.
130
- # @return [SimpleHtmlListBox]
131
160
  # @overload initialize(parent, id, pos, size, choices, style=Wx::HTML::HLB_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SimpleHtmlListBoxNameStr)
132
161
  # Constructor, creating and showing the HTML list box.
133
162
  # @param parent [Wx::Window] Parent window. Must not be NULL.
@@ -144,6 +173,104 @@ module Wx::HTML
144
173
  # @return [SimpleHtmlListBox]
145
174
  def initialize(*args) end
146
175
 
176
+ # @overload append(item)
177
+ # Appends item into the control.
178
+ # The return value is the index of the newly inserted item. Note that this may be different from the last one if the control is sorted (e.g. has {Wx::LB_SORT} or {Wx::CB_SORT} style).
179
+ # @param item [String] String to add.
180
+ # @return [Integer]
181
+ # @overload append(item, clientData)
182
+ # Appends item into the control.
183
+ # The return value is the index of the newly inserted item. Note that this may be different from the last one if the control is sorted (e.g. has {Wx::LB_SORT} or {Wx::CB_SORT} style).
184
+ # @param item [String] String to add.
185
+ # @param clientData [Object] Pointer to client data to associate with the new item.
186
+ # @return [Integer]
187
+ # @overload append(items)
188
+ # Appends several items at once into the control.
189
+ # Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
190
+ # @param items [Array<String>] Array of strings to insert.
191
+ # @return [Integer]
192
+ # @overload append(items, clientData)
193
+ # Appends several items at once into the control.
194
+ # Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
195
+ # @param items [Array<String>] Array of strings to insert.
196
+ # @param clientData [Array] Array of client data pointers of the same size as items to associate with the new items.
197
+ # @return [Integer]
198
+ def append(*args) end
199
+
200
+ # Returns a pointer to the client data associated with the given item (if any).
201
+ # It is an error to call this function for a control which doesn't have untyped client data at all although it is OK to call it even if the given item doesn't have any client data associated with it (but other items do).
202
+ #
203
+ # A pointer to the client data, or NULL if not present.
204
+ # @param n [Integer] The zero-based position of the item.
205
+ # @return [Object]
206
+ def get_client_data(n) end
207
+ alias_method :client_data, :get_client_data
208
+
209
+ # Associates the given untyped client data pointer with the given item.
210
+ # Note that it is an error to call this function if any typed client data pointers had been associated with the control items before.
211
+ # @param n [Integer] The zero-based item index.
212
+ # @param data [Object] The client data to associate with the item.
213
+ # @return [void]
214
+ def set_client_data(n, data) end
215
+
216
+ # @overload insert(item, pos)
217
+ # Inserts item into the control.
218
+ # The return value is the index of the newly inserted item. If the insertion failed for some reason, -1 is returned.
219
+ # @param item [String] String to add.
220
+ # @param pos [Integer] Position to insert item before, zero based.
221
+ # @return [Integer]
222
+ # @overload insert(item, pos, clientData)
223
+ # Inserts item into the control.
224
+ # The return value is the index of the newly inserted item. If the insertion failed for some reason, -1 is returned.
225
+ # @param item [String] String to add.
226
+ # @param pos [Integer] Position to insert item before, zero based.
227
+ # @param clientData [Object] Pointer to client data to associate with the new item.
228
+ # @return [Integer]
229
+ # @overload insert(items, pos)
230
+ # Inserts several items at once into the control.
231
+ # Notice that calling this method is usually much faster than inserting them one by one if you need to insert a lot of items.
232
+ #
233
+ # The return value is the index of the last inserted item. If the insertion failed for some reason, -1 is returned.
234
+ # @param items [Array<String>] Array of strings to insert.
235
+ # @param pos [Integer] Position to insert the items before, zero based.
236
+ # @return [Integer]
237
+ # @overload insert(items, pos, clientData)
238
+ # Inserts several items at once into the control.
239
+ # Notice that calling this method is usually much faster than inserting them one by one if you need to insert a lot of items.
240
+ #
241
+ # The return value is the index of the last inserted item. If the insertion failed for some reason, -1 is returned.
242
+ # @param items [Array<String>] Array of strings to insert.
243
+ # @param pos [Integer] Position to insert the items before, zero based.
244
+ # @param clientData [Array] Array of client data pointers of the same size as items to associate with the new items.
245
+ # @return [Integer]
246
+ def insert(*args) end
247
+
248
+ # @overload set(items)
249
+ # Replaces the current control contents with the given items.
250
+ # Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
251
+ # @param items [Array<String>] Array of strings to insert.
252
+ # @return [void]
253
+ # @overload set(items, clientData)
254
+ # Replaces the current control contents with the given items.
255
+ # Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
256
+ # @param items [Array<String>] Array of strings to insert.
257
+ # @param clientData [Array] Array of client data pointers of the same size as items to associate with the new items.
258
+ # @return [void]
259
+ def set(*args) end
260
+
261
+ # Deletes an item from the control.
262
+ # The client data associated with the item will be also deleted if it is owned by the control. Note that it is an error (signalled by an assert failure in debug builds) to remove an item with the index negative or greater or equal than the number of items in the control.
263
+ # If there is a currently selected item below the item being deleted, i.e. if {Wx::HTML::SimpleHtmlListBox#get_selection} returns a valid index greater than or equal to n, the selection is invalidated when this function is called. However if the selected item appears before the item being deleted, the selection is preserved unchanged.
264
+ # @see Wx::HTML::SimpleHtmlListBox#clear
265
+ # @param n [Integer] The zero-based item index.
266
+ # @return [void]
267
+ def delete(n) end
268
+
269
+ # Returns true, if either untyped data (<code>void*</code>) or object data ({Wx::ClientData}*) is associated with the items of the control.
270
+ # @return [true,false]
271
+ def has_client_data; end
272
+ alias_method :has_client_data?, :has_client_data
273
+
147
274
  end # SimpleHtmlListBox
148
275
 
149
276
 
@@ -273,7 +273,9 @@ module Wx::HTML
273
273
  alias_method :standard_fonts=, :set_standard_fonts
274
274
 
275
275
  # Sets the source of a page and displays it, for example:
276
- # htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
276
+ # ```
277
+ # htmlwin -> SetPage("<html><body>Hello, world!</body></html>");
278
+ # ```
277
279
  #
278
280
  # If you want to load a document from some location use {Wx::HTML::HtmlWindow#load_page} instead.
279
281
  #
@@ -319,9 +321,11 @@ module Wx::HTML
319
321
  # Adds an input filter to the static list of available filters.
320
322
  # These filters are present by default:
321
323
  #
324
+ # ```
322
325
  # text/html
323
326
  # text/plain
324
327
  # image/*
328
+ # ```
325
329
  #
326
330
  # The plain text filter will be used if no other filter matches.
327
331
  # @param filter [Wx::HtmlFilter]
@@ -358,11 +362,12 @@ module Wx::HTML
358
362
 
359
363
  # Returns true if this filter is capable of reading file file.
360
364
  # Example:
361
- #
365
+ # ```
362
366
  # bool MyFilter::CanRead(const wxFSFile& file)
363
367
  # {
364
368
  # return (file.GetMimeType() == "application/x-ugh");
365
369
  # }
370
+ # ```
366
371
  # @param file [Wx::FSFile]
367
372
  # @return [true,false]
368
373
  def can_read(file) end
@@ -370,12 +375,13 @@ module Wx::HTML
370
375
 
371
376
  # Reads the file and returns string with HTML document.
372
377
  # Example:
373
- #
378
+ # ```
374
379
  # wxString MyImgFilter::ReadFile(const wxFSFile& file)
375
380
  # {
376
381
  # return "<html><body><img src=\"" + file.GetLocation() +
377
382
  # "\"></body></html>";
378
383
  # }
384
+ # ```
379
385
  # @param file [Wx::FSFile]
380
386
  # @return [String]
381
387
  def read_file(file) end
@@ -0,0 +1,147 @@
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
+ #
10
+ HL_CONTEXTMENU = 1
11
+
12
+ #
13
+ HL_ALIGN_LEFT = 2
14
+
15
+ #
16
+ HL_ALIGN_RIGHT = 4
17
+
18
+ #
19
+ HL_ALIGN_CENTRE = 8
20
+
21
+ #
22
+ HL_DEFAULT_STYLE = 2097161
23
+
24
+ #
25
+ #
26
+ EVT_HYPERLINK = 10023
27
+
28
+ # This class shows a static text element which links to an URL.
29
+ # Appearance and behaviour is completely customizable.
30
+ # In fact, when the user clicks on the hyperlink, a {Wx::HyperlinkEvent} is sent but if that event is not handled (or it's skipped; see {Wx::Event#skip}), then a call to {launch_default_browser} is done with the hyperlink's URL.
31
+ # Note that standard {Wx::Window} functions like {Wx::Window#set_background_colour}, {Wx::Window#set_font}, {Wx::Window#set_cursor}, {Wx::Window#set_label} can be used to customize appearance of the hyperlink.
32
+ # === Styles
33
+ #
34
+ # This class supports the following styles:
35
+ #
36
+ # - {Wx::HL_ALIGN_LEFT}: Align the text to the left.
37
+ # - {Wx::HL_ALIGN_RIGHT}: Align the text to the right. This style is not supported under Windows.
38
+ # - {Wx::HL_ALIGN_CENTRE}: Center the text (horizontally). This style is not supported under Windows.
39
+ # - {Wx::HL_CONTEXTMENU}: Pop up a context menu when the hyperlink is right-clicked. The context menu contains a "Copy URL" menu item which is automatically handled by the hyperlink and which just copies in the clipboard the URL (not the label) of the control.
40
+ # - {Wx::HL_DEFAULT_STYLE}: The default style for {Wx::HyperlinkCtrl}: {Wx::Border::BORDER_NONE}|{Wx::HL_CONTEXTMENU}|{Wx::HL_ALIGN_CENTRE}.
41
+ #
42
+ # === Events emitted by this class
43
+ #
44
+ # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HyperlinkEvent} events.
45
+ # Event handler methods for events emitted by this class:
46
+ # - {Wx::EvtHandler#evt_hyperlink}(id, meth = nil, &block): The hyperlink was (left) clicked. If this event is not handled in user's code (or it's skipped; see {Wx::Event#skip}), then a call to {Wx::LaunchDefaultBrowser} is done with the hyperlink's URL.
47
+ #
48
+ # Currently this class is implemented using native support in {Wx::GTK} and {Wx::MSW} and a generic version is used by the other ports.
49
+ # ===
50
+ #
51
+ # Category: {Wx::Controls} <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
52
+ # </td><td> {Wx::GTK} Appearance
53
+ # </td><td> {Wx::OSX} Appearance
54
+ # </td></tr></table></div>
55
+ # @see Wx::URL
56
+ # @see Wx::HyperlinkEvent
57
+ #
58
+ #
59
+ class HyperlinkCtrl < Control
60
+
61
+ # @overload initialize()
62
+ # @return [HyperlinkCtrl]
63
+ # @overload initialize(parent, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HyperlinkCtrlNameStr)
64
+ # Constructor.
65
+ # See {Wx::HyperlinkCtrl#create} for more info.
66
+ # @param parent [Wx::Window]
67
+ # @param id [Integer]
68
+ # @param label [String]
69
+ # @param url [String]
70
+ # @param pos [Array(Integer, Integer), Wx::Point]
71
+ # @param size [Array(Integer, Integer), Wx::Size]
72
+ # @param style [Integer]
73
+ # @param name [String]
74
+ # @return [HyperlinkCtrl]
75
+ def initialize(*args) end
76
+
77
+ # Creates the hyperlink control.
78
+ # @param parent [Wx::Window] Parent window. Must not be NULL.
79
+ # @param id [Integer] Window identifier. A value of {Wx::StandardID::ID_ANY} indicates a default value.
80
+ # @param label [String] The label of the hyperlink.
81
+ # @param url [String] The URL associated with the given label.
82
+ # @param pos [Array(Integer, Integer), Wx::Point] Window position.
83
+ # @param size [Array(Integer, Integer), Wx::Size] Window size. If the {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
84
+ # @param style [Integer] Window style. See {Wx::HyperlinkCtrl}.
85
+ # @param name [String] Window name.
86
+ # @return [true,false]
87
+ def create(parent, id, label, url, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HL_DEFAULT_STYLE, name=Wx::HyperlinkCtrlNameStr) end
88
+
89
+ # Returns the colour used to print the label of the hyperlink when the mouse is over the control.
90
+ # @return [Wx::Colour]
91
+ def get_hover_colour; end
92
+ alias_method :hover_colour, :get_hover_colour
93
+
94
+ # Returns the colour used to print the label when the link has never been clicked before (i.e. the link has not been visited) and the mouse is not over the control.
95
+ # @return [Wx::Colour]
96
+ def get_normal_colour; end
97
+ alias_method :normal_colour, :get_normal_colour
98
+
99
+ # Returns the URL associated with the hyperlink.
100
+ # @return [String]
101
+ def get_url; end
102
+ alias_method :url, :get_url
103
+
104
+ # Returns true if the hyperlink has already been clicked by the user at least one time.
105
+ # @return [true,false]
106
+ def get_visited; end
107
+ alias_method :visited, :get_visited
108
+
109
+ # Returns the colour used to print the label when the mouse is not over the control and the link has already been clicked before (i.e. the link has been visited).
110
+ # @return [Wx::Colour]
111
+ def get_visited_colour; end
112
+ alias_method :visited_colour, :get_visited_colour
113
+
114
+ # Sets the colour used to print the label of the hyperlink when the mouse is over the control.
115
+ # @param colour [Wx::Colour,String,Symbol]
116
+ # @return [void]
117
+ def set_hover_colour(colour) end
118
+ alias_method :hover_colour=, :set_hover_colour
119
+
120
+ # Sets the colour used to print the label when the link has never been clicked before (i.e. the link has not been visited) and the mouse is not over the control.
121
+ # @param colour [Wx::Colour,String,Symbol]
122
+ # @return [void]
123
+ def set_normal_colour(colour) end
124
+ alias_method :normal_colour=, :set_normal_colour
125
+
126
+ # Sets the URL associated with the hyperlink.
127
+ # @param url [String]
128
+ # @return [void]
129
+ def set_url(url) end
130
+ alias_method :url=, :set_url
131
+
132
+ # Marks the hyperlink as visited (see {Wx::HyperlinkCtrl#set_visited_colour}).
133
+ # @param visited [true,false]
134
+ # @return [void]
135
+ def set_visited(visited=true) end
136
+ alias_method :visited=, :set_visited
137
+
138
+ # Sets the colour used to print the label when the mouse is not over the control and the link has already been clicked before (i.e. the link has been visited).
139
+ # @param colour [Wx::Colour,String,Symbol]
140
+ # @return [void]
141
+ def set_visited_colour(colour) end
142
+ alias_method :visited_colour=, :set_visited_colour
143
+
144
+ end # HyperlinkCtrl
145
+
146
+
147
+ end
@@ -0,0 +1,43 @@
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
+ # This event class is used for the events generated by {Wx::HyperlinkCtrl}.
10
+ # === Events using this class
11
+ #
12
+ # The following event-handler methods redirect the events to member method or handler blocks for {Wx::HyperlinkEvent} events.
13
+ # Event handler methods:
14
+ # - {Wx::EvtHandler#evt_hyperlink}(id, meth = nil, &block): User clicked on a hyperlink.
15
+ #
16
+ # ===
17
+ #
18
+ # Category: {Wx::Events}
19
+ #
20
+ class HyperlinkEvent < CommandEvent
21
+
22
+ # The constructor is not normally used by the user code.
23
+ # @param generator [Wx::Object]
24
+ # @param id [Integer]
25
+ # @param url [String]
26
+ # @return [HyperlinkEvent]
27
+ def initialize(generator, id, url) end
28
+
29
+ # Returns the URL of the hyperlink where the user has just clicked.
30
+ # @return [String]
31
+ def get_url; end
32
+ alias_method :url, :get_url
33
+
34
+ # Sets the URL associated with the event.
35
+ # @param url [String]
36
+ # @return [void]
37
+ def set_url(url) end
38
+ alias_method :url=, :set_url
39
+
40
+ end # HyperlinkEvent
41
+
42
+
43
+ end
@@ -32,6 +32,8 @@ module Wx
32
32
  # @see Wx::Cursor
33
33
  #
34
34
  #
35
+ #
36
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
35
37
  class Icon < GDIObject
36
38
 
37
39
  # @overload initialize()
@@ -149,6 +151,8 @@ module Wx
149
151
  # Category: Graphics Device Interface (GDI)
150
152
  # Predefined objects/pointers: {Wx::NULL_ICON_BUNDLE}
151
153
  #
154
+ #
155
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
152
156
  class IconBundle < GDIObject
153
157
 
154
158
  # Return invalid icon if exact size is not found.
@@ -231,7 +235,9 @@ module Wx
231
235
  # @return [Wx::Icon]
232
236
  # @overload get_icon(size=Wx::DEFAULT_COORD, flags=Wx::IconBundle::FALLBACK_SYSTEM)
233
237
  # Same as.
234
- # GetIcon( wxSize( size, size ) )
238
+ # ```
239
+ # GetIcon( wxSize( size, size ) )
240
+ # ```
235
241
  # .
236
242
  # @param size [Integer]
237
243
  # @param flags [Integer]
@@ -16,6 +16,8 @@ module Wx
16
16
  # @see Wx::FileType::GetIcon
17
17
  #
18
18
  #
19
+ #
20
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
19
21
  class IconLocation < ::Object
20
22
 
21
23
  # Returns true if the object is valid, i.e. was properly initialized, and false otherwise.
@@ -456,7 +456,7 @@ module Wx
456
456
  # It should be noted that although using {Wx::ImageResizeQuality::IMAGE_QUALITY_HIGH} produces much nicer looking results it is a slower method. Downsampling will use the box averaging method which seems to operate very fast. If you are upsampling larger images using this method you will most likely notice that it is a bit slower and in extreme cases it will be quite substantially slower as the bicubic algorithm has to process a lot of data.
457
457
  # It should also be noted that the high quality scaling may not work as expected when using a single mask colour for transparency, as the scaling will blur the image and will therefore remove the mask partially. Using the alpha channel will work.
458
458
  # Example:
459
- #
459
+ # ```
460
460
  # // get the bitmap from somewhere
461
461
  # wxBitmap bmp = ...;
462
462
  #
@@ -470,6 +470,7 @@ module Wx
470
470
  # image.Rescale(32, 32);
471
471
  # bmp = image;
472
472
  # }
473
+ # ```
473
474
  #
474
475
  # The algorithm used for the default (normal) quality value doesn't work with images larger than 65536 (2^16) pixels in either dimension for 32-bit programs. For 64-bit programs the limit is 2^48 and so not relevant in practice.
475
476
  # @see Wx::Image#rescale
@@ -549,6 +550,7 @@ module Wx
549
550
  # Computes the histogram of the image.
550
551
  # histogram is a reference to {Wx::ImageHistogram} object. {Wx::ImageHistogram} is a specialization of {Wx::HashMap} "template" and is defined as follows:
551
552
  #
553
+ # ```
552
554
  # class WXDLLEXPORT wxImageHistogramEntry
553
555
  # {
554
556
  # public:
@@ -560,6 +562,7 @@ module Wx
560
562
  # WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry,
561
563
  # wxIntegerHash, wxIntegerEqual,
562
564
  # wxImageHistogram);
565
+ # ```
563
566
  #
564
567
  # Returns number of colours in the histogram.
565
568
  # @param histogram [Wx::ImageHistogram]
@@ -703,7 +706,7 @@ module Wx
703
706
  # Returns the palette associated with the image.
704
707
  # Currently the palette is only used when converting to {Wx::Bitmap} under Windows.
705
708
  # Some of the {Wx::Image} handlers have been modified to set the palette if one exists in the image file (usually 256 or less colour images in GIF or PNG format).
706
- # @return [void]
709
+ # @return [Wx::Palette]
707
710
  def get_palette; end
708
711
  alias_method :palette, :get_palette
709
712
 
@@ -764,9 +767,10 @@ module Wx
764
767
  # Depending on how wxWidgets has been configured, not all formats may be available.
765
768
  #
766
769
  # You can use {Wx::Image#get_option_int} to get the hotspot when loading cursor files:
767
- #
770
+ # ```
768
771
  # int hotspot_x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
769
772
  # int hotspot_y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
773
+ # ```
770
774
  # @see Wx::Image#save_file
771
775
  # @param stream [IO,Wx::InputStream] Opened input stream from which to load the image. Currently, the stream must support seeking.
772
776
  # @param type [BitmapType] May be one of the following:
@@ -816,9 +820,10 @@ module Wx
816
820
  # Depending on how wxWidgets has been configured, not all formats may be available.
817
821
  #
818
822
  # You can use {Wx::Image#set_option} to set the hotspot when saving an image into a cursor file (default hotspot is in the centre of the image):
819
- #
823
+ # ```
820
824
  # image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_X, hotspotX);
821
825
  # image.SetOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y, hotspotY);
826
+ # ```
822
827
  # @see Wx::Image#load_file
823
828
  # @param stream [IO,Wx::OutputStream] Opened output stream to save the image to.
824
829
  # @param mimetype [String] MIME type.
@@ -889,10 +894,11 @@ module Wx
889
894
  # Sets the flags used for loading image files by this object.
890
895
  # The flags will affect any future calls to {Wx::Image#load_file} for this object. To change the flags for all image objects, call {Wx::Image.set_default_load_flags} before creating any of them.
891
896
  # Currently the only defined flag is Load_Verbose which determines if the non-fatal (i.e. not preventing the file from being loaded completely) problems should result in the calls to {log_warning} function. It is recommended to customize handling of these warnings by e.g. defining a custom log target (see Logging Overview), but if such warnings should be completely suppressed, clearing this flag provides a simple way to do it, for example:
892
- #
897
+ # ```
893
898
  # wxImage image;
894
899
  # image.SetLoadFlags(image.GetLoadFlags() & ~wxImage::Load_Verbose);
895
900
  # image.LoadFile(...);
901
+ # ```
896
902
  # @see Wx::Image#load_file
897
903
  # @see Wx::Image#set_load_flags
898
904
  # @see Wx::Image#get_load_flags
@@ -1057,7 +1063,6 @@ module Wx
1057
1063
  # @return [Image]
1058
1064
  # @overload initialize(xpmData)
1059
1065
  # Creates an image from XPM data.
1060
- # <b>{Wx::Perl} Note:</b> Not supported by {Wx::Perl}.
1061
1066
  # This constructor has become explicit in wxWidgets 3.1.6.
1062
1067
  # @param xpmData [char] A pointer to XPM image data.
1063
1068
  # @return [Image]
@@ -1066,9 +1071,10 @@ module Wx
1066
1071
  # Depending on how wxWidgets has been configured and by which handlers have been loaded, not all formats may be available. Any handler other than BMP must be previously initialized with {Wx::Image.add_handler} or {init_all_image_handlers}.
1067
1072
  #
1068
1073
  # You can use {Wx::Image#get_option_int} to get the hotspot when loading cursor files:
1069
- #
1074
+ # ```
1070
1075
  # int hotspot_x = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
1071
1076
  # int hotspot_y = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
1077
+ # ```
1072
1078
  # @see Wx::Image#load_file
1073
1079
  # @param name [String] Name of the file from which to load the image.
1074
1080
  # @param type [BitmapType] May be one of the following:
@@ -1120,10 +1126,11 @@ module Wx
1120
1126
 
1121
1127
  # Iterates all registered {Wx::ImageHandler} objects, and returns a string containing file extension masks suitable for passing to file open/save dialog boxes.
1122
1128
  # The format of the returned string is <code>"(*.ext1;*.ext2)|*.ext1;*.ext2"</code>. It is usually a good idea to prepend a description before passing the result to the dialog. Example:
1123
- #
1129
+ # ```
1124
1130
  # wxFileDialog FileDlg( this, "Choose Image", ::wxGetCwd(), "",
1125
1131
  # _("Image Files ") + wxImage::GetImageExtWildcard(),
1126
1132
  # wxFD_OPEN );
1133
+ # ```
1127
1134
  # @see Wx::ImageHandler
1128
1135
  # @return [String]
1129
1136
  def self.get_image_ext_wildcard; end
@@ -16,6 +16,8 @@ module Wx
16
16
  # @see Wx::MouseState
17
17
  #
18
18
  #
19
+ #
20
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
19
21
  class KeyboardState < ::Object
20
22
 
21
23
  # Constructor initializes the modifier key settings.
@@ -31,13 +33,17 @@ module Wx
31
33
  # The return value is a combination of {Wx::KeyModifier::MOD_ALT}, {Wx::KeyModifier::MOD_CONTROL}, {Wx::KeyModifier::MOD_SHIFT} and {Wx::KeyModifier::MOD_META} bit masks. Additionally, {Wx::KeyModifier::MOD_NONE} is defined as 0, i.e. corresponds to no modifiers (see {Wx::KeyboardState#has_any_modifiers}) and {Wx::KeyModifier::MOD_CMD} is either {Wx::KeyModifier::MOD_CONTROL} (MSW and Unix) or {Wx::KeyModifier::MOD_META} (Mac), see {Wx::KeyboardState#cmd_down}. See {Wx::KeyModifier} for the full list of modifiers.
32
34
  # Notice that this function is easier to use correctly than, for example, {Wx::KeyboardState#control_down} because when using the latter you also have to remember to test that none of the other modifiers is pressed:
33
35
  #
36
+ # ```
34
37
  # if ( ControlDown() && !AltDown() && !ShiftDown() && !MetaDown() )
35
38
  # ... handle Ctrl-XXX ...
39
+ # ```
36
40
  #
37
41
  # and forgetting to do it can result in serious program bugs (e.g. program not working with European keyboard layout where AltGr key which is seen by the program as combination of CTRL and ALT is used). On the other hand, you can simply write:
38
42
  #
43
+ # ```
39
44
  # if ( GetModifiers() == wxMOD_CONTROL )
40
45
  # ... handle Ctrl-XXX ...
46
+ # ```
41
47
  #
42
48
  # with this function.
43
49
  # @return [Integer]
@@ -77,7 +77,6 @@ module Wx
77
77
  # @return [ListBox]
78
78
  # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ListBoxNameStr)
79
79
  # Constructor, creating and showing a list box.
80
- # <b>{Wx::Perl} Note:</b> Not supported by {Wx::Perl}.
81
80
  # @param parent [Wx::Window] The parent window.
82
81
  # @param id [Integer] The ID of this control. A value of {Wx::StandardID::ID_ANY} indicates a default value.
83
82
  # @param pos [Array(Integer, Integer), Wx::Point] The initial position. If {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
@@ -90,7 +89,6 @@ module Wx
90
89
  # @overload initialize(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::ListBoxNameStr)
91
90
  # Constructor, creating and showing a list box.
92
91
  # See the other {Wx::ListBox#list_box} constructor; the only difference is that this overload takes a {Wx::ArrayString} instead of a pointer to an array of {Wx::String}.
93
- # <b>{Wx::Perl} Note:</b> Use an array reference for the choices parameter.
94
92
  # @param parent [Wx::Window]
95
93
  # @param id [Integer]
96
94
  # @param pos [Array(Integer, Integer), Wx::Point]
@@ -141,8 +139,6 @@ module Wx
141
139
  # The number of selections.
142
140
  #
143
141
  # Use this with a multiple selection listbox.
144
- #
145
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes no parameters and return the selected items as a list.
146
142
  # @see Wx::ControlWithItems::GetSelection
147
143
  # @see Wx::ControlWithItems::GetStringSelection
148
144
  # @see Wx::ControlWithItems::SetSelection
@@ -165,7 +161,6 @@ module Wx
165
161
  def hit_test(*args) end
166
162
 
167
163
  # Insert the given number of strings before the specified position.
168
- # <b>{Wx::Perl} Note:</b> Use an array reference for the items parameter.
169
164
  # @param items [Array<String>] Labels of items to be inserted
170
165
  # @param pos [Integer] Position before which to insert the items: if pos is 0 the items will be inserted in the beginning of the listbox
171
166
  # @return [void]
@@ -195,12 +190,6 @@ module Wx
195
190
  # @return [void]
196
191
  def ensure_visible(n) end
197
192
 
198
- # Return true if the listbox has {Wx::LB_SORT} style.
199
- # This method is mostly meant for internal use only.
200
- # @return [true,false]
201
- def is_sorted; end
202
- alias_method :sorted?, :is_sorted
203
-
204
193
  # Return the number of items that can fit vertically in the visible area of the listbox.
205
194
  # Returns -1 if the number of items per page couldn't be determined. On {Wx::GTK} this method can only determine the number of items per page if there is at least one item in the listbox.
206
195
  # @return [void]