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
@@ -16,16 +16,10 @@ module Wx::PRT
16
16
  #
17
17
  # Category: Device Contexts
18
18
  #
19
+ #
20
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
19
21
  class PostScriptDC < DC
20
22
 
21
- # @overload initialize()
22
- # @return [PostScriptDC]
23
- # @overload initialize(printData)
24
- # Constructs a PostScript printer device context from a {Wx::PRT::PrintData} object.
25
- # @param printData [Wx::PrintData]
26
- # @return [PostScriptDC]
27
- def initialize(*args) end
28
-
29
23
  end # PostScriptDC
30
24
 
31
25
 
@@ -91,6 +91,8 @@ module Wx::PRT
91
91
  # @see Wx::PRT::PostScriptDC
92
92
  #
93
93
  #
94
+ #
95
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
94
96
  class PrintData < Object
95
97
 
96
98
  # @overload initialize()
@@ -266,6 +268,8 @@ module Wx::PRT
266
268
  # @see wxPrintDialog Overview
267
269
  #
268
270
  #
271
+ #
272
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
269
273
  class PrintDialogData < Object
270
274
 
271
275
  # @overload initialize()
@@ -423,6 +427,8 @@ module Wx::PRT
423
427
  # @see Wx::PRT::PageSetupDialog
424
428
  #
425
429
  #
430
+ #
431
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
426
432
  class PageSetupDialogData < Object
427
433
 
428
434
  # @overload initialize()
@@ -152,7 +152,6 @@ module Wx::PRT
152
152
  # Returns the number of pixels per logical inch of the printer device context.
153
153
  # Dividing the printer PPI by the screen PPI can give a suitable scaling factor for drawing text onto the printer.
154
154
  # Remember to multiply this by a scaling factor to take the preview DC size into account. Or you can just use the FitThisSizeToXXX() and MapScreenSizeToXXX routines below, which do most of the scaling calculations for you.
155
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes no arguments and returns a 2-element list (w, h).
156
155
  # @return [Array(Integer,Integer)]
157
156
  def get_ppi_printer; end
158
157
  alias_method :ppi_printer, :get_ppi_printer
@@ -160,7 +159,6 @@ module Wx::PRT
160
159
  # Returns the number of pixels per logical inch of the screen device context.
161
160
  # Dividing the printer PPI by the screen PPI can give a suitable scaling factor for drawing text onto the printer.
162
161
  # If you are doing your own scaling, remember to multiply this by a scaling factor to take the preview DC size into account.
163
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes no arguments and returns a 2-element list (w, h).
164
162
  # @return [Array(Integer,Integer)]
165
163
  def get_ppi_screen; end
166
164
  alias_method :ppi_screen, :get_ppi_screen
@@ -173,7 +171,6 @@ module Wx::PRT
173
171
  alias_method :page_info, :get_page_info
174
172
 
175
173
  # Returns the size of the printer page in millimetres.
176
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes no arguments and returns a 2-element list (w, h).
177
174
  # @return [Array(Integer,Integer)]
178
175
  def get_page_size_mm; end
179
176
  alias_method :page_size_mm, :get_page_size_mm
@@ -15,14 +15,10 @@ module Wx::PRT
15
15
  # @see Wx::DC
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 PrinterDC < DC
19
21
 
20
- # Constructor.
21
- # Pass a {Wx::PRT::PrintData} object with information necessary for setting up a suitable printer device context. This is the recommended way to construct a {Wx::PRT::PrinterDC}. Make sure you specify a reference to a {Wx::PRT::PrintData} object, not a pointer - you may not even get a warning if you pass a pointer instead.
22
- # @param printData [Wx::PrintData]
23
- # @return [PrinterDC]
24
- def initialize(printData) end
25
-
26
22
  # Return the rectangle in device coordinates that corresponds to the full paper area, including the nonprinting regions of the paper.
27
23
  # The point (0,0) in device coordinates is the top left corner of the page rectangle, which is the printable area on MSW and Mac. The coordinates of the top left corner of the paper rectangle will therefore have small negative values, while the bottom right coordinates will be somewhat larger than the values returned by {Wx::DC#get_size}.
28
24
  # @return [Wx::Rect]
@@ -42,7 +42,7 @@ module Wx
42
42
  # @return [RadioBox]
43
43
  # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, majorDimension=0, style=Wx::RA_SPECIFY_COLS, validator=Wx::DEFAULT_VALIDATOR, name=Wx::RadioBoxNameStr)
44
44
  # Constructor, creating and showing a radiobox.
45
- # <b>{Wx::Perl} Note:</b> Not supported by {Wx::Perl}.
45
+ #
46
46
  # @see Wx::RadioBox#create
47
47
  # @see Wx::Validator
48
48
  # @param parent [Wx::Window] Parent window. Must not be NULL.
@@ -58,7 +58,7 @@ module Wx
58
58
  # @return [RadioBox]
59
59
  # @overload initialize(parent, id, label, pos, size, choices, majorDimension=0, style=Wx::RA_SPECIFY_COLS, validator=Wx::DEFAULT_VALIDATOR, name=Wx::RadioBoxNameStr)
60
60
  # Constructor, creating and showing a radiobox.
61
- # <b>{Wx::Perl} Note:</b> Use an array reference for the choices parameter.
61
+ #
62
62
  # @see Wx::RadioBox#create
63
63
  # @see Wx::Validator
64
64
  # @param parent [Wx::Window] Parent window. Must not be NULL.
@@ -182,14 +182,6 @@ module Wx
182
182
  def set_selection(n) end
183
183
  alias_method :selection=, :set_selection
184
184
 
185
- # Shows or hides individual buttons.
186
- # true if the item has been shown or hidden or false if nothing was done because it already was in the requested state.
187
- # @see Wx::Window#show
188
- # @param item [Integer] The zero-based position of the button to show or hide.
189
- # @param show [true,false] true to show, false to hide.
190
- # @return [true,false]
191
- def show(item, show=true) end
192
-
193
185
  # Returns the number of items in the control.
194
186
  #
195
187
  # @see Wx::RadioBox#is_empty
@@ -1052,6 +1052,8 @@ module Wx::RBN
1052
1052
  #
1053
1053
  #
1054
1054
  #
1055
+ #
1056
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
1055
1057
  class RibbonPageTabInfo < ::Object
1056
1058
 
1057
1059
  end # RibbonPageTabInfo
@@ -1059,6 +1061,8 @@ module Wx::RBN
1059
1061
  #
1060
1062
  #
1061
1063
  #
1064
+ #
1065
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
1062
1066
  class RibbonMSWArtProvider < RibbonArtProvider
1063
1067
 
1064
1068
  # @param set_colour_scheme [true,false]
@@ -1432,6 +1436,8 @@ module Wx::RBN
1432
1436
  #
1433
1437
  #
1434
1438
  #
1439
+ #
1440
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
1435
1441
  class RibbonAUIArtProvider < RibbonMSWArtProvider
1436
1442
 
1437
1443
  # @return [RibbonAUIArtProvider]
@@ -140,7 +140,7 @@ module Wx::RBN
140
140
  # Get the bitmap to be used in place of the panel children when it is minimised.
141
141
  # @return [Wx::Bitmap]
142
142
  # @overload get_minimised_icon()
143
- # @return [void]
143
+ # @return [Wx::Bitmap]
144
144
  def get_minimised_icon(*args) end
145
145
  alias_method :minimised_icon, :get_minimised_icon
146
146
 
@@ -37,6 +37,8 @@ module Wx
37
37
  # @see Wx::RegionIterator
38
38
  #
39
39
  #
40
+ #
41
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
40
42
  class Region < GDIObject
41
43
 
42
44
  # @overload get_box(x, y, width, height)
@@ -547,6 +547,8 @@ module Wx::RTC
547
547
  # @see wxRichTextAttrBorders
548
548
  #
549
549
  #
550
+ #
551
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
550
552
  class TextAttrBorder < ::Object
551
553
 
552
554
  # Default constructor.
@@ -700,6 +702,8 @@ module Wx::RTC
700
702
  # @see wxRichTextAttrBorder
701
703
  #
702
704
  #
705
+ #
706
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
703
707
  class TextAttrBorders < ::Object
704
708
 
705
709
  # Default constructor.
@@ -816,6 +820,8 @@ module Wx::RTC
816
820
  # @see Wx::RTC::RichTextCtrl
817
821
  #
818
822
  #
823
+ #
824
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
819
825
  class TextBoxAttr < ::Object
820
826
 
821
827
  # @overload initialize()
@@ -577,7 +577,6 @@ module Wx::RTC
577
577
  # Gets the attributes at the given position.
578
578
  # This function gets the combined style - that is, the style you see on the screen as a result of combining base style, paragraph style and character style attributes.
579
579
  # To get the character or paragraph style alone, use {Wx::RTC::RichTextCtrl#get_uncombined_style}.
580
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method is implemented as GetStyle(position) returning a 2-element list (ok, attr).
581
580
  # @param position [Integer]
582
581
  # @param style [Wx::TextAttr]
583
582
  # @return [true,false]
@@ -630,7 +629,6 @@ module Wx::RTC
630
629
  # Gets the attributes at the given position.
631
630
  # This function gets the uncombined style - that is, the attributes associated with the paragraph or character content, and not necessarily the combined attributes you see on the screen. To get the combined attributes, use {Wx::RTC::RichTextCtrl#get_style}.
632
631
  # If you specify (any) paragraph attribute in style's flags, this function will fetch the paragraph attributes. Otherwise, it will return the character attributes.
633
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method is implemented as GetUncombinedStyle(position) returning a 2-element list (ok, attr).
634
632
  # @param position [Integer]
635
633
  # @param style [Wx::RichTextAttr]
636
634
  # @return [true,false]
@@ -1817,7 +1815,6 @@ module Wx::RTC
1817
1815
 
1818
1816
  # Returns the caret height and position for the given character position.
1819
1817
  # If container is null, the current focus object will be used.
1820
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method is implemented as GetCaretPositionForIndex(position) returning a 2-element list (ok, rect).
1821
1818
  # @param position [Integer]
1822
1819
  # @param rect [Wx::Rect]
1823
1820
  # @param container [Wx::RichTextParagraphLayoutBox]
@@ -1839,7 +1836,6 @@ module Wx::RTC
1839
1836
 
1840
1837
  # Deletes content if there is a selection, e.g.
1841
1838
  # when pressing a key. Returns the new caret position in newPos, or leaves it if there was no action. This is undoable.
1842
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes no arguments and returns a 2-element list (ok, newPos).
1843
1839
  # @return [Array(true,false,Integer)]
1844
1840
  def delete_selected_content; end
1845
1841
 
@@ -56,6 +56,8 @@ module Wx::RTC
56
56
  #
57
57
  # Category: Rich Text
58
58
  #
59
+ #
60
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
59
61
  class RichTextHeaderFooterData < Object
60
62
 
61
63
  # @overload initialize()
@@ -64,7 +64,7 @@ module Wx::RTC
64
64
 
65
65
  # Sets the mapping for converting point sizes to HTML font sizes.
66
66
  # There should be 7 elements, one for each HTML font size, each element specifying the maximum point size for that HTML font size. For example:
67
- #
67
+ # ```
68
68
  # wxArrayInt fontSizeMapping;
69
69
  # fontSizeMapping.Add(7);
70
70
  # fontSizeMapping.Add(9);
@@ -75,6 +75,7 @@ module Wx::RTC
75
75
  # fontSizeMapping.Add(100);
76
76
  #
77
77
  # htmlHandler.SetFontSizeMapping(fontSizeMapping);
78
+ # ```
78
79
  # @param fontSizeMapping [Array<Integer>]
79
80
  # @return [void]
80
81
  def set_font_size_mapping(fontSizeMapping) end
@@ -13,6 +13,7 @@ module Wx::RTC
13
13
  # When the dialog is dismissed, the application can get the selected symbol with {Wx::RTC::SymbolPickerDialog#get_symbol} and test whether a font was specified with {Wx::RTC::SymbolPickerDialog#use_normal_font},fetching the specified font with {Wx::RTC::SymbolPickerDialog#get_font_name}.
14
14
  # Here's a realistic example, inserting the supplied symbol into a rich text control in either the current font or specified font.
15
15
  #
16
+ # ```
16
17
  # wxRichTextCtrl* ctrl = (wxRichTextCtrl*) FindWindow(ID_RICHTEXT_CTRL);
17
18
  #
18
19
  # wxTextAttr attr;
@@ -46,6 +47,7 @@ module Wx::RTC
46
47
  # }
47
48
  # }
48
49
  # }
50
+ # ```
49
51
  #
50
52
  # ===
51
53
  #
@@ -19,6 +19,8 @@ module Wx
19
19
  # @see Wx::WindowDC
20
20
  #
21
21
  #
22
+ #
23
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
22
24
  class ScreenDC < DC
23
25
 
24
26
  end # ScreenDC
@@ -120,8 +120,9 @@ module Wx
120
120
 
121
121
  # Sets the scrollbar properties.
122
122
  # Let's say you wish to display 50 lines of text, using the same font. The window is sized so that you can only see 16 lines at a time. You would use:
123
- #
123
+ # ```
124
124
  # scrollbar->SetScrollbar(0, 16, 50, 15);
125
+ # ```
125
126
  # The page size is 1 less than the thumb size so that the last line of the previous page will be visible on the next page, to help orient the user. Note that with the window at this size, the thumb position can never go above 50 minus 16, or 34. You can determine how many lines are currently visible by dividing the current view size by the character height in pixels. When defining your own scrollbar behaviour, you will always need to recalculate the scrollbar settings when the window size changes. You could therefore put your scrollbar calculations and {Wx::ScrollBar#set_scrollbar} call into a function named AdjustScrollbars, which can be called initially and also from a {Wx::SizeEvent} event handler function.
126
127
  # @param position [Integer] The position of the scrollbar in scroll units.
127
128
  # @param thumbSize [Integer] The size of the thumb, or visible portion of the scrollbar, in scroll units.
@@ -84,7 +84,6 @@ module Wx
84
84
  # @overload calc_scrolled_position(x, y)
85
85
  # Translates the logical coordinates to the device ones.
86
86
  # For example, if a window is scrolled 10 pixels to the bottom, the device coordinates of the origin are (0, 0) (as always), but the logical coordinates are (0, 10) and so the call to CalcScrolledPosition(0, 10, xx, yy) will return 0 in yy.
87
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes two parameters and returns a 2-element list (xx, yy).
88
87
  # @see Wx::Scrolled#calc_unscrolled_position
89
88
  # @param x [Integer]
90
89
  # @param y [Integer]
@@ -97,7 +96,6 @@ module Wx
97
96
  # @overload calc_unscrolled_position(x, y)
98
97
  # Translates the device coordinates to the logical ones.
99
98
  # For example, if a window is scrolled 10 pixels to the bottom, the device coordinates of the origin are (0, 0) (as always), but the logical coordinates are (0, 10) and so the call to CalcUnscrolledPosition(0, 0, xx, yy) will return 10 in yy.
100
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes two parameters and returns a 2-element list (xx, yy).
101
99
  # @see Wx::Scrolled#calc_scrolled_position
102
100
  # @param x [Integer]
103
101
  # @param y [Integer]
@@ -127,7 +125,7 @@ module Wx
127
125
  # Call this function to prepare the device context for drawing a scrolled image.
128
126
  # It sets the device origin according to the current scroll position. Wx::Scrolled#do_prepare_dc is called automatically within the default {Wx::EVT_PAINT} event handler, so your Wx::Scrolled#on_draw override will be passed an already 'pre-scrolled' device context. However, if you wish to draw from outside of Wx::Scrolled#on_draw (e.g. from your own {Wx::EVT_PAINT} handler), you must call this function yourself.
129
127
  # For example:
130
- #
128
+ # ```
131
129
  # void MyWindow::OnEvent(wxMouseEvent& event)
132
130
  # {
133
131
  # wxClientDC dc(this);
@@ -143,6 +141,7 @@ module Wx
143
141
  # xpos = x;
144
142
  # ypos = y;
145
143
  # }
144
+ # ```
146
145
  #
147
146
  # Notice that the function sets the origin by moving it relatively to the current origin position, so you shouldn't change the origin before calling Wx::Scrolled#do_prepare_dc or, if you do, reset it to (0, 0) later. If you call Wx::Scrolled#do_prepare_dc immediately after device context creation, as in the example above, this problem doesn't arise, of course, so it is customary to do it like this.
148
147
  # @param dc [Wx::DC]
@@ -169,8 +168,6 @@ module Wx
169
168
 
170
169
  # Get the number of pixels per scroll unit (line), in each direction, as set by Wx::Scrolled#set_scrollbars.
171
170
  # A value of zero indicates no scrolling in that direction.
172
- #
173
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes no parameters and returns a 2-element list (xUnit, yUnit).
174
171
  # @see Wx::Scrolled#set_scrollbars
175
172
  # @see Wx::Scrolled#get_virtual_size
176
173
  # @return [Array(Integer,Integer)]
@@ -184,8 +181,6 @@ module Wx
184
181
 
185
182
  # Gets the size in device units of the scrollable window area (as opposed to the client size, which is the area of the window currently visible).
186
183
  # Use {Wx::DC#device_to_logical_x} and {Wx::DC#device_to_logical_y} to translate these units to logical units.
187
- #
188
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes no parameters and returns a 2-element list (xUnit, yUnit).
189
184
  # @see Wx::Scrolled#set_scrollbars
190
185
  # @see Wx::Scrolled#get_scroll_pixels_per_unit
191
186
  # @return [Array(Integer,Integer)]
@@ -228,8 +223,9 @@ module Wx
228
223
  # The first pair of parameters give the number of pixels per 'scroll step', i.e. amount moved when the up or down scroll arrows are pressed. The second pair gives the length of scrollbar in scroll steps, which sets the size of the virtual window.
229
224
  # xPos and yPos optionally specify a position to scroll to immediately.
230
225
  # For example, the following gives a window horizontal and vertical scrollbars with 20 pixels per scroll step, and a size of 50 steps (1000 pixels) in each direction:
231
- #
226
+ # ```
232
227
  # window->SetScrollbars(20, 20, 50, 50);
228
+ # ```
233
229
  #
234
230
  # {Wx::Scrolled} manages the page size itself, using the current client window size as the page size.
235
231
  # Note that for more sophisticated scrolling applications, for example where scroll steps may be variable according to the position in the document, it will be necessary to derive a new class from {Wx::Window}, overriding OnSize() and adjusting the scrollbars appropriately.
@@ -84,7 +84,6 @@ module Wx
84
84
  # @overload calc_scrolled_position(x, y)
85
85
  # Translates the logical coordinates to the device ones.
86
86
  # For example, if a window is scrolled 10 pixels to the bottom, the device coordinates of the origin are (0, 0) (as always), but the logical coordinates are (0, 10) and so the call to CalcScrolledPosition(0, 10, xx, yy) will return 0 in yy.
87
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes two parameters and returns a 2-element list (xx, yy).
88
87
  # @see Wx::Scrolled#calc_unscrolled_position
89
88
  # @param x [Integer]
90
89
  # @param y [Integer]
@@ -97,7 +96,6 @@ module Wx
97
96
  # @overload calc_unscrolled_position(x, y)
98
97
  # Translates the device coordinates to the logical ones.
99
98
  # For example, if a window is scrolled 10 pixels to the bottom, the device coordinates of the origin are (0, 0) (as always), but the logical coordinates are (0, 10) and so the call to CalcUnscrolledPosition(0, 0, xx, yy) will return 10 in yy.
100
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes two parameters and returns a 2-element list (xx, yy).
101
99
  # @see Wx::Scrolled#calc_scrolled_position
102
100
  # @param x [Integer]
103
101
  # @param y [Integer]
@@ -127,7 +125,7 @@ module Wx
127
125
  # Call this function to prepare the device context for drawing a scrolled image.
128
126
  # It sets the device origin according to the current scroll position. Wx::Scrolled#do_prepare_dc is called automatically within the default {Wx::EVT_PAINT} event handler, so your Wx::Scrolled#on_draw override will be passed an already 'pre-scrolled' device context. However, if you wish to draw from outside of Wx::Scrolled#on_draw (e.g. from your own {Wx::EVT_PAINT} handler), you must call this function yourself.
129
127
  # For example:
130
- #
128
+ # ```
131
129
  # void MyWindow::OnEvent(wxMouseEvent& event)
132
130
  # {
133
131
  # wxClientDC dc(this);
@@ -143,6 +141,7 @@ module Wx
143
141
  # xpos = x;
144
142
  # ypos = y;
145
143
  # }
144
+ # ```
146
145
  #
147
146
  # Notice that the function sets the origin by moving it relatively to the current origin position, so you shouldn't change the origin before calling Wx::Scrolled#do_prepare_dc or, if you do, reset it to (0, 0) later. If you call Wx::Scrolled#do_prepare_dc immediately after device context creation, as in the example above, this problem doesn't arise, of course, so it is customary to do it like this.
148
147
  # @param dc [Wx::DC]
@@ -169,8 +168,6 @@ module Wx
169
168
 
170
169
  # Get the number of pixels per scroll unit (line), in each direction, as set by Wx::Scrolled#set_scrollbars.
171
170
  # A value of zero indicates no scrolling in that direction.
172
- #
173
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes no parameters and returns a 2-element list (xUnit, yUnit).
174
171
  # @see Wx::Scrolled#set_scrollbars
175
172
  # @see Wx::Scrolled#get_virtual_size
176
173
  # @return [Array(Integer,Integer)]
@@ -184,8 +181,6 @@ module Wx
184
181
 
185
182
  # Gets the size in device units of the scrollable window area (as opposed to the client size, which is the area of the window currently visible).
186
183
  # Use {Wx::DC#device_to_logical_x} and {Wx::DC#device_to_logical_y} to translate these units to logical units.
187
- #
188
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes no parameters and returns a 2-element list (xUnit, yUnit).
189
184
  # @see Wx::Scrolled#set_scrollbars
190
185
  # @see Wx::Scrolled#get_scroll_pixels_per_unit
191
186
  # @return [Array(Integer,Integer)]
@@ -228,8 +223,9 @@ module Wx
228
223
  # The first pair of parameters give the number of pixels per 'scroll step', i.e. amount moved when the up or down scroll arrows are pressed. The second pair gives the length of scrollbar in scroll steps, which sets the size of the virtual window.
229
224
  # xPos and yPos optionally specify a position to scroll to immediately.
230
225
  # For example, the following gives a window horizontal and vertical scrollbars with 20 pixels per scroll step, and a size of 50 steps (1000 pixels) in each direction:
231
- #
226
+ # ```
232
227
  # window->SetScrollbars(20, 20, 50, 50);
228
+ # ```
233
229
  #
234
230
  # {Wx::Scrolled} manages the page size itself, using the current client window size as the page size.
235
231
  # Note that for more sophisticated scrolling applications, for example where scroll steps may be variable according to the position in the document, it will be necessary to derive a new class from {Wx::Window}, overriding OnSize() and adjusting the scrollbars appropriately.
@@ -104,7 +104,6 @@ module Wx
104
104
  # @overload calc_scrolled_position(x, y)
105
105
  # Translates the logical coordinates to the device ones.
106
106
  # For example, if a window is scrolled 10 pixels to the bottom, the device coordinates of the origin are (0, 0) (as always), but the logical coordinates are (0, 10) and so the call to CalcScrolledPosition(0, 10, xx, yy) will return 0 in yy.
107
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes two parameters and returns a 2-element list (xx, yy).
108
107
  # @see Wx::Scrolled#calc_unscrolled_position
109
108
  # @param x [Integer]
110
109
  # @param y [Integer]
@@ -117,7 +116,6 @@ module Wx
117
116
  # @overload calc_unscrolled_position(x, y)
118
117
  # Translates the device coordinates to the logical ones.
119
118
  # For example, if a window is scrolled 10 pixels to the bottom, the device coordinates of the origin are (0, 0) (as always), but the logical coordinates are (0, 10) and so the call to CalcUnscrolledPosition(0, 0, xx, yy) will return 10 in yy.
120
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes two parameters and returns a 2-element list (xx, yy).
121
119
  # @see Wx::Scrolled#calc_scrolled_position
122
120
  # @param x [Integer]
123
121
  # @param y [Integer]
@@ -147,7 +145,7 @@ module Wx
147
145
  # Call this function to prepare the device context for drawing a scrolled image.
148
146
  # It sets the device origin according to the current scroll position. Wx::Scrolled#do_prepare_dc is called automatically within the default {Wx::EVT_PAINT} event handler, so your Wx::Scrolled#on_draw override will be passed an already 'pre-scrolled' device context. However, if you wish to draw from outside of Wx::Scrolled#on_draw (e.g. from your own {Wx::EVT_PAINT} handler), you must call this function yourself.
149
147
  # For example:
150
- #
148
+ # ```
151
149
  # void MyWindow::OnEvent(wxMouseEvent& event)
152
150
  # {
153
151
  # wxClientDC dc(this);
@@ -163,6 +161,7 @@ module Wx
163
161
  # xpos = x;
164
162
  # ypos = y;
165
163
  # }
164
+ # ```
166
165
  #
167
166
  # Notice that the function sets the origin by moving it relatively to the current origin position, so you shouldn't change the origin before calling Wx::Scrolled#do_prepare_dc or, if you do, reset it to (0, 0) later. If you call Wx::Scrolled#do_prepare_dc immediately after device context creation, as in the example above, this problem doesn't arise, of course, so it is customary to do it like this.
168
167
  # @param dc [Wx::DC]
@@ -189,8 +188,6 @@ module Wx
189
188
 
190
189
  # Get the number of pixels per scroll unit (line), in each direction, as set by Wx::Scrolled#set_scrollbars.
191
190
  # A value of zero indicates no scrolling in that direction.
192
- #
193
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes no parameters and returns a 2-element list (xUnit, yUnit).
194
191
  # @see Wx::Scrolled#set_scrollbars
195
192
  # @see Wx::Scrolled#get_virtual_size
196
193
  # @return [Array(Integer,Integer)]
@@ -204,8 +201,6 @@ module Wx
204
201
 
205
202
  # Gets the size in device units of the scrollable window area (as opposed to the client size, which is the area of the window currently visible).
206
203
  # Use {Wx::DC#device_to_logical_x} and {Wx::DC#device_to_logical_y} to translate these units to logical units.
207
- #
208
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes no parameters and returns a 2-element list (xUnit, yUnit).
209
204
  # @see Wx::Scrolled#set_scrollbars
210
205
  # @see Wx::Scrolled#get_scroll_pixels_per_unit
211
206
  # @return [Array(Integer,Integer)]
@@ -248,8 +243,9 @@ module Wx
248
243
  # The first pair of parameters give the number of pixels per 'scroll step', i.e. amount moved when the up or down scroll arrows are pressed. The second pair gives the length of scrollbar in scroll steps, which sets the size of the virtual window.
249
244
  # xPos and yPos optionally specify a position to scroll to immediately.
250
245
  # For example, the following gives a window horizontal and vertical scrollbars with 20 pixels per scroll step, and a size of 50 steps (1000 pixels) in each direction:
251
- #
246
+ # ```
252
247
  # window->SetScrollbars(20, 20, 50, 50);
248
+ # ```
253
249
  #
254
250
  # {Wx::Scrolled} manages the page size itself, using the current client window size as the page size.
255
251
  # Note that for more sophisticated scrolling applications, for example where scroll steps may be variable according to the position in the document, it will be necessary to derive a new class from {Wx::Window}, overriding OnSize() and adjusting the scrollbars appropriately.
@@ -0,0 +1,131 @@
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
+ #
11
+ EVT_SEARCH_CANCEL = 10129
12
+
13
+ #
14
+ #
15
+ EVT_SEARCH = 10130
16
+
17
+ # A search control is a composite control with a search button, a text control, and a cancel button.
18
+ # This control is implemented natively under macOS and GTK 3.6 or later and generically for all the other platforms.
19
+ # Please note that this class provides many {Wx::TextCtrl}-like methods, but does not necessarily derive from {Wx::TextCtrl} in all ports (although it does in the generic version). Only the methods defined in {Wx::TextEntry} interface class are guaranteed to be available under all platforms.
20
+ # === Styles
21
+ #
22
+ # This class supports the following styles:
23
+ #
24
+ # - {Wx::TE_PROCESS_TAB}: The control will receive {Wx::EVT_CHAR} events for TAB pressed - normally, TAB is used for passing to the next control in a dialog instead. For the control created with this style, you can still use Ctrl-Enter to pass to the next control from the keyboard.
25
+ # - {Wx::TE_NOHIDESEL}: By default, the Windows text control doesn't show the selection when it doesn't have focus - use this style to force it to always show it. It doesn't do anything under other platforms.
26
+ # - {Wx::TE_LEFT}: The text in the control will be left-justified (default).
27
+ # - {Wx::TE_CENTRE}: The text in the control will be centered (currently {Wx::MSW} and {Wx::GTK2} only).
28
+ # - {Wx::TE_RIGHT}: The text in the control will be right-justified (currently {Wx::MSW} and {Wx::GTK2} only).
29
+ # - {Wx::TE_CAPITALIZE}: On PocketPC and Smartphone, causes the first letter to be capitalized.
30
+ #
31
+ # === Events emitted by this class
32
+ #
33
+ # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CommandEvent} events.
34
+ # Event handler methods for events emitted by this class:{Wx::TextCtrl}. However it is recommended to use {Wx::EVT_SEARCH} to actually start searching to avoid doing it too soon, while the user is still typing (note that {Wx::EVT_SEARCH} is also triggered by pressing Enter in the control).
35
+ # - {Wx::EvtHandler#evt_search}(id, meth = nil, &block): Respond to a {Wx::EVT_SEARCH} event, generated when the search button is clicked. Note that this does not initiate a search on its own, you need to perform the appropriate action in your event handler. You may use
36
+ # - {Wx::EvtHandler#evt_search_cancel}(id, meth = nil, &block): Respond to a {Wx::EVT_SEARCH_CANCEL} event, generated when the cancel button is clicked.
37
+ #
38
+ # ===
39
+ #
40
+ # Category: {Wx::Controls} <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
41
+ # </td><td> {Wx::GTK} Appearance
42
+ # </td><td> {Wx::OSX} Appearance
43
+ # </td></tr></table></div>
44
+ # @see Wx::TextCtrl
45
+ #
46
+ #
47
+ class SearchCtrl < Control
48
+
49
+ include Wx::TextEntry
50
+
51
+ # @overload initialize()
52
+ # Default constructor.
53
+ # @return [SearchCtrl]
54
+ # @overload initialize(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SearchCtrlNameStr)
55
+ # Constructor, creating and showing a text control.
56
+ #
57
+ # @see Wx::TextCtrl#create
58
+ # @see Wx::Validator
59
+ # @param parent [Wx::Window] Parent window. Should not be NULL.
60
+ # @param id [Integer] Control identifier. A value of -1 denotes a default value.
61
+ # @param value [String] Default text value.
62
+ # @param pos [Array(Integer, Integer), Wx::Point] Text control position.
63
+ # @param size [Array(Integer, Integer), Wx::Size] Text control size.
64
+ # @param style [Integer] Window style. See {Wx::SearchCtrl}.
65
+ # @param validator [Wx::Validator] Window validator.
66
+ # @param name [String] Window name.
67
+ # @return [SearchCtrl]
68
+ def initialize(*args) end
69
+
70
+ # @param parent [Wx::Window]
71
+ # @param id [Integer]
72
+ # @param value [String]
73
+ # @param pos [Array(Integer, Integer), Wx::Point]
74
+ # @param size [Array(Integer, Integer), Wx::Size]
75
+ # @param style [Integer]
76
+ # @param validator [Wx::Validator]
77
+ # @param name [String]
78
+ # @return [true,false]
79
+ def create(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::SearchCtrlNameStr) end
80
+
81
+ # Returns a pointer to the search control's menu object or NULL if there is no menu attached.
82
+ # @return [Wx::Menu]
83
+ def get_menu; end
84
+ alias_method :menu, :get_menu
85
+
86
+ # Returns the search button visibility value.
87
+ # If there is a menu attached, the search button will be visible regardless of the search button visibility value.
88
+ # @return [true,false]
89
+ def is_search_button_visible; end
90
+ alias_method :search_button_visible?, :is_search_button_visible
91
+
92
+ # Returns the cancel button's visibility state.
93
+ # @return [true,false]
94
+ def is_cancel_button_visible; end
95
+ alias_method :cancel_button_visible?, :is_cancel_button_visible
96
+
97
+ # Sets the search control's menu object.
98
+ # If there is already a menu associated with the search control it is deleted.
99
+ # @param menu [Wx::Menu] Menu to attach to the search control.
100
+ # @return [void]
101
+ def set_menu(menu) end
102
+ alias_method :menu=, :set_menu
103
+
104
+ # Shows or hides the cancel button.
105
+ # Note that this function does nothing in the native GTK version of the control: "Cancel" button is always shown automatically if the control is not empty and hidden if it is empty.
106
+ # @param show [true,false]
107
+ # @return [void]
108
+ def show_cancel_button(show) end
109
+
110
+ # Sets the search button visibility value on the search control.
111
+ # If there is a menu attached, the search button will be visible regardless of the search button visibility value.
112
+ # Note that this function does nothing in the native GTK version of the control: "Search" button is always shown there.
113
+ # @param show [true,false]
114
+ # @return [void]
115
+ def show_search_button(show) end
116
+
117
+ # Set the text to be displayed in the search control when the user has not yet typed anything in it.
118
+ # @param text [String]
119
+ # @return [void]
120
+ def set_descriptive_text(text) end
121
+ alias_method :descriptive_text=, :set_descriptive_text
122
+
123
+ # Return the text displayed when there is not yet any user input.
124
+ # @return [String]
125
+ def get_descriptive_text; end
126
+ alias_method :descriptive_text, :get_descriptive_text
127
+
128
+ end # SearchCtrl
129
+
130
+
131
+ end
@@ -36,8 +36,6 @@ module Wx
36
36
 
37
37
  # Constructor, taking an array of {Wx::String} choices and optional client data.
38
38
  # Use {Wx::SingleChoiceDialog#show_modal} to show the dialog.
39
- #
40
- # <b>{Wx::Perl} Note:</b> Use an array reference for the choices parameter.
41
39
  # @param parent [Wx::Window] Parent window.
42
40
  # @param message [String] Message to show on the dialog.
43
41
  # @param caption [String] The dialog caption.