wxruby3 0.9.0.pre.beta.13-x64-mingw-ucrt → 0.9.0.pre.rc.1-x64-mingw-ucrt

Sign up to get free protection for your applications and to get access to all the features.
Files changed (240) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -0
  3. data/README.md +47 -4
  4. data/assets/hello_button.png +0 -0
  5. data/assets/hello_button_clicked.png +0 -0
  6. data/assets/hello_world.png +0 -0
  7. data/assets/repo-social-preview.png +0 -0
  8. data/ext/wxbase32u_gcc_custom.dll +0 -0
  9. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  10. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  11. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  12. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  18. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  19. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  20. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  21. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  22. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  23. data/lib/wx/accessors.rb +8 -2
  24. data/lib/wx/core/art_locator.rb +2 -2
  25. data/lib/wx/core/artprovider.rb +2 -2
  26. data/lib/wx/core/bitmap.rb +6 -5
  27. data/lib/wx/core/bitmap_combobox.rb +34 -0
  28. data/lib/wx/core/controlwithitems.rb +52 -14
  29. data/lib/wx/core/cursor.rb +1 -1
  30. data/lib/wx/core/dc.rb +0 -20
  31. data/lib/wx/core/event_blocker.rb +14 -0
  32. data/lib/wx/core/events/evt_list.rb +12 -0
  33. data/lib/wx/core/evthandler.rb +36 -0
  34. data/lib/wx/core/find_replace_dialog.rb +24 -0
  35. data/lib/wx/core/icon.rb +1 -1
  36. data/lib/wx/core/image.rb +1 -1
  37. data/lib/wx/core/paintdc.rb +8 -0
  38. data/lib/wx/core/text_entry.rb +15 -0
  39. data/lib/wx/core/v_list_box.rb +13 -0
  40. data/lib/wx/core/window.rb +1 -1
  41. data/lib/wx/doc/busy_info.rb +21 -0
  42. data/lib/wx/doc/client_dc.rb +28 -0
  43. data/lib/wx/doc/controlwithitems.rb +11 -0
  44. data/lib/wx/doc/dc.rb +0 -14
  45. data/lib/wx/doc/event_blocker.rb +27 -0
  46. data/lib/wx/doc/evthandler.rb +4 -0
  47. data/lib/wx/doc/extra/02_lifecycles.md +49 -0
  48. data/lib/wx/doc/extra/10_art.md +1 -1
  49. data/lib/wx/doc/extra/11_drawing_and_dc.md +62 -0
  50. data/lib/wx/doc/gen/about_dialog_info.rb +27 -24
  51. data/lib/wx/doc/gen/accelerator.rb +11 -12
  52. data/lib/wx/doc/gen/app.rb +6 -3
  53. data/lib/wx/doc/gen/art_provider.rb +53 -29
  54. data/lib/wx/doc/gen/aui/aui_manager.rb +4 -0
  55. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +1 -1
  56. data/lib/wx/doc/gen/aui/aui_pane_info.rb +2 -0
  57. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +2 -0
  58. data/lib/wx/doc/gen/bitmap.rb +25 -25
  59. data/lib/wx/doc/gen/bitmap_combo_box.rb +157 -0
  60. data/lib/wx/doc/gen/box_sizer.rb +6 -8
  61. data/lib/wx/doc/gen/brush.rb +2 -0
  62. data/lib/wx/doc/gen/busy_info.rb +52 -46
  63. data/lib/wx/doc/gen/caret.rb +0 -4
  64. data/lib/wx/doc/gen/check_list_box.rb +0 -2
  65. data/lib/wx/doc/gen/choice.rb +1 -5
  66. data/lib/wx/doc/gen/client_dc.rb +13 -18
  67. data/lib/wx/doc/gen/clipboard.rb +30 -27
  68. data/lib/wx/doc/gen/collapsible_pane.rb +11 -9
  69. data/lib/wx/doc/gen/colour.rb +6 -3
  70. data/lib/wx/doc/gen/colour_dialog.rb +111 -23
  71. data/lib/wx/doc/gen/combo_box.rb +2 -4
  72. data/lib/wx/doc/gen/control.rb +20 -18
  73. data/lib/wx/doc/gen/core.rb +2 -2
  74. data/lib/wx/doc/gen/cursor.rb +18 -50
  75. data/lib/wx/doc/gen/data_format.rb +0 -2
  76. data/lib/wx/doc/gen/data_object.rb +37 -44
  77. data/lib/wx/doc/gen/dc.rb +16 -24
  78. data/lib/wx/doc/gen/defs.rb +3 -40
  79. data/lib/wx/doc/gen/dialog.rb +21 -17
  80. data/lib/wx/doc/gen/dir_dialog.rb +10 -8
  81. data/lib/wx/doc/gen/event.rb +2 -2
  82. data/lib/wx/doc/gen/event_blocker.rb +49 -0
  83. data/lib/wx/doc/gen/event_filter.rb +95 -0
  84. data/lib/wx/doc/gen/event_list.rb +16 -2
  85. data/lib/wx/doc/gen/events.rb +103 -112
  86. data/lib/wx/doc/gen/evt_handler.rb +28 -52
  87. data/lib/wx/doc/gen/file_dialog.rb +8 -4
  88. data/lib/wx/doc/gen/find_replace_dialog.rb +1 -1
  89. data/lib/wx/doc/gen/font.rb +10 -2
  90. data/lib/wx/doc/gen/font_data.rb +2 -0
  91. data/lib/wx/doc/gen/font_dialog.rb +1 -1
  92. data/lib/wx/doc/gen/frame.rb +4 -3
  93. data/lib/wx/doc/gen/fs_file.rb +8 -0
  94. data/lib/wx/doc/gen/gcdc.rb +2 -22
  95. data/lib/wx/doc/gen/gdi_common.rb +18 -2
  96. data/lib/wx/doc/gen/gdi_object.rb +2 -0
  97. data/lib/wx/doc/gen/graphics_context.rb +4 -43
  98. data/lib/wx/doc/gen/graphics_object.rb +2 -0
  99. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +2 -1
  100. data/lib/wx/doc/gen/grid/grid_ctrl.rb +4 -2
  101. data/lib/wx/doc/gen/grid/grid_table_message.rb +2 -0
  102. data/lib/wx/doc/gen/grid_bag_sizer.rb +4 -0
  103. data/lib/wx/doc/gen/help_controller.rb +4 -1
  104. data/lib/wx/doc/gen/html/html_cell.rb +4 -1
  105. data/lib/wx/doc/gen/html/html_help_controller.rb +4 -1
  106. data/lib/wx/doc/gen/html/html_help_data.rb +4 -0
  107. data/lib/wx/doc/gen/html/html_help_window.rb +2 -1
  108. data/lib/wx/doc/gen/html/html_list_box.rb +138 -11
  109. data/lib/wx/doc/gen/html/html_window.rb +9 -3
  110. data/lib/wx/doc/gen/icon.rb +7 -1
  111. data/lib/wx/doc/gen/icon_location.rb +2 -0
  112. data/lib/wx/doc/gen/image.rb +15 -8
  113. data/lib/wx/doc/gen/keyboard_state.rb +6 -0
  114. data/lib/wx/doc/gen/list_box.rb +0 -11
  115. data/lib/wx/doc/gen/list_ctrl.rb +10 -13
  116. data/lib/wx/doc/gen/locale.rb +7 -3
  117. data/lib/wx/doc/gen/log.rb +6 -2
  118. data/lib/wx/doc/gen/mdi_frame.rb +2 -0
  119. data/lib/wx/doc/gen/media_ctrl.rb +2 -0
  120. data/lib/wx/doc/gen/memory_dc.rb +105 -18
  121. data/lib/wx/doc/gen/menu.rb +4 -2
  122. data/lib/wx/doc/gen/menu_bar.rb +0 -2
  123. data/lib/wx/doc/gen/menu_item.rb +9 -3
  124. data/lib/wx/doc/gen/message_dialog.rb +6 -3
  125. data/lib/wx/doc/gen/mirror_dc.rb +2 -8
  126. data/lib/wx/doc/gen/mouse_state.rb +2 -0
  127. data/lib/wx/doc/gen/multi_choice_dialog.rb +0 -2
  128. data/lib/wx/doc/gen/non_owned_window.rb +2 -1
  129. data/lib/wx/doc/gen/notebook.rb +4 -2
  130. data/lib/wx/doc/gen/paint_dc.rb +2 -6
  131. data/lib/wx/doc/gen/palette.rb +3 -3
  132. data/lib/wx/doc/gen/pen.rb +6 -1
  133. data/lib/wx/doc/gen/pg/pg_editor.rb +2 -1
  134. data/lib/wx/doc/gen/pg/pg_multi_button.rb +4 -0
  135. data/lib/wx/doc/gen/pg/pg_properties.rb +30 -3
  136. data/lib/wx/doc/gen/pg/pg_property.rb +30 -4
  137. data/lib/wx/doc/gen/pg/pg_validation_info.rb +2 -0
  138. data/lib/wx/doc/gen/pg/property_grid.rb +5 -2
  139. data/lib/wx/doc/gen/pg/property_grid_interface.rb +6 -2
  140. data/lib/wx/doc/gen/pg/property_grid_manager.rb +2 -0
  141. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +2 -0
  142. data/lib/wx/doc/gen/picker_base.rb +2 -1
  143. data/lib/wx/doc/gen/platform_info.rb +4 -1
  144. data/lib/wx/doc/gen/property_sheet_dialog.rb +2 -0
  145. data/lib/wx/doc/gen/prt/post_script_dc.rb +2 -8
  146. data/lib/wx/doc/gen/prt/print_data.rb +6 -0
  147. data/lib/wx/doc/gen/prt/printer.rb +0 -3
  148. data/lib/wx/doc/gen/prt/printer_dc.rb +2 -6
  149. data/lib/wx/doc/gen/radio_box.rb +2 -2
  150. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +6 -0
  151. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +1 -1
  152. data/lib/wx/doc/gen/region.rb +2 -0
  153. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +6 -0
  154. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +0 -4
  155. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +2 -0
  156. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +2 -1
  157. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +2 -0
  158. data/lib/wx/doc/gen/screen_dc.rb +2 -0
  159. data/lib/wx/doc/gen/scroll_bar.rb +2 -1
  160. data/lib/wx/doc/gen/scrolled_canvas.rb +4 -8
  161. data/lib/wx/doc/gen/scrolled_control.rb +4 -8
  162. data/lib/wx/doc/gen/scrolled_window.rb +4 -8
  163. data/lib/wx/doc/gen/search_ctrl.rb +131 -0
  164. data/lib/wx/doc/gen/single_choice_dialog.rb +0 -2
  165. data/lib/wx/doc/gen/sizer.rb +14 -3
  166. data/lib/wx/doc/gen/splash_screen.rb +2 -0
  167. data/lib/wx/doc/gen/static_box.rb +6 -3
  168. data/lib/wx/doc/gen/static_box_sizer.rb +2 -1
  169. data/lib/wx/doc/gen/status_bar.rb +0 -5
  170. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +4 -5
  171. data/lib/wx/doc/gen/svg_file_dc.rb +10 -11
  172. data/lib/wx/doc/gen/text_ctrl.rb +10 -3
  173. data/lib/wx/doc/gen/text_entry.rb +8 -3
  174. data/lib/wx/doc/gen/text_entry_dialog.rb +4 -2
  175. data/lib/wx/doc/gen/timer_event.rb +2 -0
  176. data/lib/wx/doc/gen/tool_bar.rb +8 -4
  177. data/lib/wx/doc/gen/top_level_window.rb +5 -2
  178. data/lib/wx/doc/gen/tree_ctrl.rb +0 -6
  179. data/lib/wx/doc/gen/ui_action_simulator.rb +100 -0
  180. data/lib/wx/doc/gen/utils.rb +1 -1
  181. data/lib/wx/doc/gen/v_list_box.rb +36 -26
  182. data/lib/wx/doc/gen/validator.rb +2 -1
  183. data/lib/wx/doc/gen/variant.rb +10 -0
  184. data/lib/wx/doc/gen/window.rb +38 -17
  185. data/lib/wx/doc/gen/window_dc.rb +2 -0
  186. data/lib/wx/doc/gen/window_disabler.rb +2 -0
  187. data/lib/wx/doc/gen/wizard_page_simple.rb +2 -0
  188. data/lib/wx/doc/gen/xml_node.rb +6 -0
  189. data/lib/wx/doc/gen/xml_resource.rb +4 -1
  190. data/lib/wx/doc/memory_dc.rb +75 -0
  191. data/lib/wx/doc/mirror_dc.rb +16 -0
  192. data/lib/wx/doc/prt/printer_dc.rb +26 -0
  193. data/lib/wx/doc/screen_dc.rb +10 -6
  194. data/lib/wx/doc/svg_file_dc.rb +20 -0
  195. data/lib/wx/doc/v_list_box.rb +9 -0
  196. data/lib/wx/doc/window_disabler.rb +10 -0
  197. data/lib/wx/global_const.rb +24 -18
  198. data/lib/wx/html/keyword_defs.rb +6 -7
  199. data/lib/wx/html/require.rb +1 -0
  200. data/lib/wx/html/simple_html_listbox.rb +105 -0
  201. data/lib/wx/keyword_defs.rb +7 -0
  202. data/lib/wx/version.rb +1 -1
  203. data/lib/wx/wxruby/cmd/test.rb +1 -1
  204. data/lib/wxruby_aui.so +0 -0
  205. data/lib/wxruby_core.so +0 -0
  206. data/lib/wxruby_grid.so +0 -0
  207. data/lib/wxruby_html.so +0 -0
  208. data/lib/wxruby_pg.so +0 -0
  209. data/lib/wxruby_prt.so +0 -0
  210. data/lib/wxruby_rbn.so +0 -0
  211. data/lib/wxruby_rtc.so +0 -0
  212. data/lib/wxruby_stc.so +0 -0
  213. data/rakelib/install.rb +3 -1
  214. data/rakelib/yard/yard/relative_markdown_links.rb +5 -1
  215. data/samples/bigdemo/wxArtProvider.rbw +5 -4
  216. data/samples/controls/controls.rb +2 -2
  217. data/samples/controls/htlbox.rb +411 -0
  218. data/samples/controls/tn_htlbox.png +0 -0
  219. data/samples/drawing/graphics_drawing.rb +1 -2
  220. data/samples/drawing/{svgtest.rb → image_prt.rb} +49 -18
  221. data/samples/drawing/tn_image_prt.png +0 -0
  222. data/samples/propgrid/propgrid.rb +23 -21
  223. data/samples/ribbon/ribbon.rb +47 -46
  224. data/tests/lib/wxapp_runner.rb +3 -3
  225. data/tests/lib/wxframe_runner.rb +59 -0
  226. data/tests/test_app_event_filter.rb +74 -0
  227. data/tests/test_art_provider.rb +52 -0
  228. data/tests/test_clipboard.rb +2 -1
  229. data/tests/test_event_handling.rb +199 -16
  230. data/tests/test_events.rb +4 -11
  231. data/tests/test_gdi_object.rb +161 -0
  232. data/tests/test_intl.rb +11 -14
  233. data/tests/test_item_data.rb +33 -1
  234. data/tests/test_std_controls.rb +147 -0
  235. metadata +38 -8
  236. data/lib/wx/doc/gen/auto_buffered_paint_dc.rb +0 -47
  237. data/lib/wx/doc/gen/buffered_dc.rb +0 -95
  238. data/lib/wx/doc/gen/buffered_paint_dc.rb +0 -55
  239. data/lib/wx/doc/gen/colour_data.rb +0 -96
  240. data/samples/drawing/tn_svgtest.png +0 -0
@@ -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.
@@ -222,8 +222,9 @@ module Wx
222
222
 
223
223
  # This base function adds non-stretchable space to both the horizontal and vertical orientation of the sizer.
224
224
  # More readable way of calling:
225
- #
225
+ # ```
226
226
  # wxSizer::Add(size, size, 0).
227
+ # ```
227
228
  # @see Wx::BoxSizer#add_spacer
228
229
  # @param size [Integer]
229
230
  # @return [Wx::SizerItem]
@@ -231,8 +232,9 @@ module Wx
231
232
 
232
233
  # Adds stretchable space to the sizer.
233
234
  # More readable way of calling:
234
- #
235
+ # ```
235
236
  # wxSizer::Add(0, 0, prop).
237
+ # ```
236
238
  # @param prop [Integer]
237
239
  # @return [Wx::SizerItem]
238
240
  def add_stretch_spacer(prop=1) end
@@ -623,7 +625,7 @@ module Wx
623
625
  # This method first calls {Wx::Sizer#fit} and then {Wx::TopLevelWindow#set_size_hints} on the window passed to it.
624
626
  # This function is only when window is actually a {Wx::TopLevelWindow} such as a {Wx::Frame} or a {Wx::Dialog}, since SetSizeHints only has any effect in these classes. It does nothing in normal windows or controls.
625
627
  # Note that window does not need to be the window using this sizer and it is, in fact, common to call this function on the sizer associated with the panel covering the client area of a frame passing it the frame pointer, as this has the desired effect of adjusting the frame size to the size fitting the panel, e.g.:
626
- #
628
+ # ```
627
629
  # MyFrame::MyFrame(...) : wxFrame(...)
628
630
  # {
629
631
  # wxPanel* panel = new wxPanel(this);
@@ -636,6 +638,7 @@ module Wx
636
638
  # // frame to fit its contents.
637
639
  # sizer->SetSizeHints(this);
638
640
  # }
641
+ # ```
639
642
  #
640
643
  # This function is also used by {Wx::Window#set_sizer_and_fit} which is commonly invoked in the constructor of {Wx::Dialog}-derived classes, which don't need to use an intermediate panel, see the example in wxBoxSizer overview.
641
644
  # @param window [Wx::Window]
@@ -686,19 +689,25 @@ module Wx
686
689
  # Container for sizer items flags providing readable names for them.
687
690
  # Normally, when you add an item to a sizer via {Wx::Sizer#add}, you have to specify a lot of flags and parameters which can be unwieldy. This is where {Wx::SizerFlags} comes in: it allows you to specify all parameters using the named methods instead. For example, instead of
688
691
  #
692
+ # ```
689
693
  # sizer->Add(ctrl, 0, wxEXPAND | wxALL, 10);
694
+ # ```
690
695
  #
691
696
  # you can now write
692
697
  #
698
+ # ```
693
699
  # sizer->Add(ctrl, wxSizerFlags().Expand().Border(wxALL, 10));
700
+ # ```
694
701
  #
695
702
  # This is more readable and also allows you to create {Wx::SizerFlags} objects which can be reused for several sizer items.
696
703
  #
704
+ # ```
697
705
  # wxSizerFlags flagsExpand(1);
698
706
  # flagsExpand.Expand().Border(wxALL, 10);
699
707
  #
700
708
  # sizer->Add(ctrl1, flagsExpand);
701
709
  # sizer->Add(ctrl2, flagsExpand);
710
+ # ```
702
711
  #
703
712
  # Note that by specification, all methods of {Wx::SizerFlags} return the {Wx::SizerFlags} object itself to allowing chaining multiple methods calls like in the examples above.
704
713
  # ===
@@ -707,6 +716,8 @@ module Wx
707
716
  # @see Wx::Sizer
708
717
  #
709
718
  #
719
+ #
720
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
710
721
  class SizerFlags < ::Object
711
722
 
712
723
  # Creates the {Wx::Sizer} with the proportion specified by proportion.
@@ -25,6 +25,7 @@ module Wx
25
25
  # Show it in application initialisation, and then either explicitly destroy it or let it time-out.
26
26
  # Example usage:
27
27
  #
28
+ # ```
28
29
  # wxBitmap bitmap;
29
30
  # if (bitmap.LoadFile("splash16.png", wxBITMAP_TYPE_PNG))
30
31
  # {
@@ -34,6 +35,7 @@ module Wx
34
35
  # wxBORDER_SIMPLE|wxSTAY_ON_TOP);
35
36
  # }
36
37
  # wxYield();
38
+ # ```
37
39
  #
38
40
  # ===
39
41
  #
@@ -9,7 +9,7 @@ module Wx
9
9
  # A static box is a rectangle drawn around other windows to denote a logical grouping of items.
10
10
  # Note that while the previous versions required that windows appearing inside a static box be created as its siblings (i.e. use the same parent as the static box itself), since wxWidgets 2.9.1 it is possible to create them as children of {Wx::StaticBox} itself and doing this is strongly recommended and avoids several different repainting problems that could happen when creating the other windows as siblings of the box.
11
11
  # So the recommended way to create static box and the controls inside it is:
12
- #
12
+ # ```
13
13
  # void MyFrame::CreateControls()
14
14
  # {
15
15
  # wxPanel *panel = new wxPanel(this);
@@ -18,6 +18,7 @@ module Wx
18
18
  # new wxStaticText(box, wxID_ANY, "This window is a child of the staticbox");
19
19
  # ...
20
20
  # }
21
+ # ```
21
22
  #
22
23
  # Creating the windows with the static box parent (i.e. panel in the example above) as parent still works but can result in refresh and repaint problems.
23
24
  # Also note that there is a specialized {Wx::Sizer} class ({Wx::StaticBoxSizer}) which can be used as an easier way to pack items into a static box.
@@ -53,7 +54,7 @@ module Wx
53
54
  # This constructor takes a pointer to an arbitrary window (although usually a {Wx::CheckBox} or a {Wx::RadioButton}) instead of just the usual text label and puts this window at the top of the box at the place where the label would be shown.
54
55
  # The label window must be a non-null, fully created window and will become a child of this {Wx::StaticBox}, i.e. it will be owned by this control and will be deleted when the {Wx::StaticBox} itself is deleted.
55
56
  # An example of creating a {Wx::StaticBox} with window as a label:
56
- #
57
+ # ```
57
58
  # void MyFrame::CreateControls()
58
59
  # {
59
60
  # wxPanel* panel = new wxPanel(this);
@@ -61,6 +62,7 @@ module Wx
61
62
  # wxStaticBox* box = new wxStaticBox(panel, wxID_ANY, checkbox);
62
63
  # ...
63
64
  # }
65
+ # ```
64
66
  #
65
67
  # Currently this constructor is only available in {Wx::GTK} and {Wx::MSW}, use {Wx::HAS_WINDOW_LABEL_IN_STATIC_BOX} to check whether it can be used at compile-time.
66
68
  # @param parent [Wx::Window]
@@ -102,13 +104,14 @@ module Wx
102
104
  # Enables or disables the box without affecting its label window, if any.
103
105
  # {Wx::StaticBox} overrides {Wx::Window#enable} in order to avoid disabling the control used as a label, if this box is using one. This is done in order to allow using a {Wx::CheckBox}, for example, label and enable or disable the box according to the state of the checkbox: if disabling the box also disabled the checkbox in this situation, it would make it impossible for the user to re-enable the box after disabling it, so the checkbox stays enabled even if <code>box->Enable(false)</code> is called.
104
106
  # However with the actual behaviour, implemented in this overridden method, the following code (shown using C++11 only for convenience, this behaviour is not C++11-specific):
105
- #
107
+ # ```
106
108
  # auto check = new wxCheckBox(parent, wxID_ANY, "Use the box");
107
109
  # auto box = new wxStaticBox(parent, wxID_ANY, check);
108
110
  # check->Bind(wxEVT_CHECKBOX,
109
111
  # [box](wxCommandEvent& event) {
110
112
  # box->Enable(event.IsChecked());
111
113
  # });
114
+ # ```
112
115
  # does work as expected.
113
116
  # Please note that overriding {Wx::StaticBox#enable} to not actually disable this window itself has two possibly unexpected consequences:
114
117
  #
@@ -10,7 +10,7 @@ module Wx
10
10
  # The static box may be either created independently or the sizer may create it itself as a convenience. In any case, the sizer owns the {Wx::StaticBox} control and will delete it in the {Wx::StaticBoxSizer} destructor.
11
11
  # Note that since wxWidgets 2.9.1 you are strongly encouraged to create the windows which are added to {Wx::StaticBoxSizer} as children of {Wx::StaticBox} itself, see this class documentation for more details.
12
12
  # Example of use of this class:
13
- #
13
+ # ```
14
14
  # void MyFrame::CreateControls()
15
15
  # {
16
16
  # wxPanel *panel = new wxPanel(this);
@@ -20,6 +20,7 @@ module Wx
20
20
  # "This window is a child of the staticbox"));
21
21
  # ...
22
22
  # }
23
+ # ```
23
24
  #
24
25
  # ===
25
26
  #
@@ -90,8 +90,6 @@ module Wx
90
90
 
91
91
  # Returns the size and position of a field's internal bounding rectangle.
92
92
  # true if the field index is valid, false otherwise.
93
- #
94
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this function returns a Wx::Rect if the field index is valid, undef otherwise.
95
93
  # @see Wx::Rect
96
94
  # @param i [Integer] The field in question.
97
95
  # @return [Array(true,false,Wx::Rect)]
@@ -153,7 +151,6 @@ module Wx
153
151
  def push_status_text(string, field=0) end
154
152
 
155
153
  # Sets the number of fields, and optionally the field widths.
156
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this function accepts only the number parameter. Use SetStatusWidths to set the field widths.
157
154
  # @param number [Integer] The number of fields. If this is greater than the previous number, then new fields with empty strings will be added to the status bar.
158
155
  # @param widths [Array<Integer>] An array of n integers interpreted in the same way as in {Wx::StatusBar#set_status_widths}.
159
156
  # @return [void]
@@ -189,8 +186,6 @@ module Wx
189
186
  # For example, to create one fixed width field of width 100 in the right part of the status bar and two more fields which get 66% and 33% of the remaining space correspondingly, you should use an array containing -2, -1 and 100.
190
187
  #
191
188
  # The widths of the variable fields are calculated from the total width of all fields, minus the sum of widths of the non-variable fields, divided by the number of variable fields.
192
- #
193
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes as parameters the field widths.
194
189
  # @see Wx::StatusBar#set_fields_count
195
190
  # @see Wx::Frame#set_status_widths
196
191
  # @param widths_field [Array<Integer>] Contains an array of n integers, each of which is either an absolute status field width in pixels if positive or indicates a variable width field if negative. The special value NULL means that all fields should get the same width.
@@ -25,6 +25,8 @@ module Wx::STC
25
25
  #
26
26
  class StyledTextCtrl < Control
27
27
 
28
+ include Wx::TextEntry
29
+
28
30
  # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STCNameStr)
29
31
  # Ctor.
30
32
  # @param parent [Wx::Window]
@@ -3850,6 +3852,7 @@ module Wx::STC
3850
3852
  # Notice that insertion position is, in general, different from the index of the character the cursor position at in the string returned by {Wx::STC::StyledTextCtrl#get_value}. While this is always the case for the single line controls, multi-line controls can use two characters <code>"\\r\\n"</code> as line separator (this is notably the case under MSW) meaning that indices in the control and its string value are offset by 1 for every line.
3851
3853
  # Hence to correctly get the character at the current cursor position, taking into account that there can be none if the cursor is at the end of the string, you could do the following:
3852
3854
  #
3855
+ # ```
3853
3856
  # wxString GetCurrentChar(wxTextCtrl *tc)
3854
3857
  # {
3855
3858
  # long pos = tc->GetInsertionPoint();
@@ -3858,6 +3861,7 @@ module Wx::STC
3858
3861
  #
3859
3862
  # return tc->GetRange(pos, pos + 1);
3860
3863
  # }
3864
+ # ```
3861
3865
  # @return [Integer]
3862
3866
  def get_insertion_point; end
3863
3867
  alias_method :insertion_point, :get_insertion_point
@@ -3882,8 +3886,6 @@ module Wx::STC
3882
3886
 
3883
3887
  # Gets the current selection span.
3884
3888
  # If the returned values are equal, there was no selection. Please note that the indices returned may be used with the other {Wx::TextCtrl} methods but don't necessarily represent the correct indices into the string returned by {Wx::STC::StyledTextCtrl#get_value} for multiline controls under Windows (at least,) you should use {Wx::STC::StyledTextCtrl#get_string_selection} to get the selected text.
3885
- #
3886
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes no parameters and returns a 2-element list (from, to).
3887
3889
  # @return [Array(Integer, Integer)]
3888
3890
  def get_selection; end
3889
3891
  alias_method :selection, :get_selection
@@ -3968,8 +3970,6 @@ module Wx::STC
3968
3970
 
3969
3971
  # Converts given position to a zero-based column, line number pair.
3970
3972
  # true on success, false on failure (most likely due to a too large position parameter).
3971
- #
3972
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this function takes only the pos argument and returns a 2-element list (x, y).
3973
3973
  # @see Wx::STC::StyledTextCtrl#xy_to_position
3974
3974
  # @param pos [Integer] Position.
3975
3975
  # @return [Array(true,false,Array(Integer, Integer))]
@@ -3983,7 +3983,6 @@ module Wx::STC
3983
3983
  # Finds the row and column of the character at the specified point.
3984
3984
  # If the return code is not {Wx::TextCtrlHitTestResult::TE_HT_UNKNOWN} the row and column of the character closest to this position are returned, otherwise the output parameters are not modified.
3985
3985
  # Please note that this function is currently only implemented in {Wx::Univ}, {Wx::MSW} and {Wx::GTK2} ports and always returns {Wx::TextCtrlHitTestResult::TE_HT_UNKNOWN} in the other ports.
3986
- # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this function takes only the pt argument and returns a 3-element list (result, col, row).
3987
3986
  # @see Wx::STC::StyledTextCtrl#position_to_xy
3988
3987
  # @see Wx::STC::StyledTextCtrl#xy_to_position
3989
3988
  # @param pt [Array(Integer, Integer), Wx::Point] The position of the point to check, in window device coordinates.
@@ -43,26 +43,19 @@ module Wx
43
43
  #
44
44
  # Category: Device Contexts
45
45
  #
46
+ #
47
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
46
48
  class SVGFileDC < DC
47
49
 
48
- # Initializes a {Wx::SVGFileDC} with the given filename, width and height at dpi resolution, and an optional title.
49
- # The title provides a readable name for the SVG document.
50
- # @param filename [String]
51
- # @param width [Integer]
52
- # @param height [Integer]
53
- # @param dpi [Float]
54
- # @param title [String]
55
- # @return [SVGFileDC]
56
- def initialize(filename, width=320, height=240, dpi=72, title=(())) end
57
-
58
50
  # Draws a rectangle the size of the SVG using the {Wx::DC#set_background} brush.
59
51
  # @return [void]
60
52
  def clear; end
61
53
 
62
54
  # Replaces the default bitmap handler with handler.
63
55
  # By default, an object of {Wx::SVGBitmapFileHandler} class is used as bitmap handler. You may want to replace it with an object of predefined {Wx::SVGBitmapEmbedHandler} class to embed the bitmaps in the generated SVG instead of storing them in separate files like this:
64
- #
56
+ # ```
65
57
  # mySVGFileDC->SetBitmapHandler(new wxSVGBitmapEmbedHandler());
58
+ # ```
66
59
  #
67
60
  # or derive your own bitmap handler class and use it if you need to customize the bitmap handling further.
68
61
  # @param handler [Wx::SVGBitmapHandler] The new bitmap handler. If non-NULL, this object takes ownership of this handler and will delete it when it is not needed any more.
@@ -88,6 +81,8 @@ module Wx
88
81
  #
89
82
  # Category: Device Contexts
90
83
  #
84
+ #
85
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
91
86
  class SVGBitmapHandler < ::Object
92
87
 
93
88
  # Writes the bitmap representation as SVG to the given stream.
@@ -111,6 +106,8 @@ module Wx
111
106
  # @see Wx::SVGFileDC#set_bitmap_handler.
112
107
  #
113
108
  #
109
+ #
110
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
114
111
  class SVGBitmapFileHandler < SVGBitmapHandler
115
112
 
116
113
  # Create a {Wx::SVGBitmapFileHandler} and specify the location where the file will be saved.
@@ -136,6 +133,8 @@ module Wx
136
133
  # @see Wx::SVGFileDC#set_bitmap_handler.
137
134
  #
138
135
  #
136
+ #
137
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
139
138
  class SVGBitmapEmbedHandler < SVGBitmapHandler
140
139
 
141
140
  # Writes the bitmap representation as SVG to the given stream.