wxruby3 1.6.0 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (541) hide show
  1. checksums.yaml +4 -4
  2. data/CREDITS.md +32 -25
  3. data/INSTALL.md +21 -6
  4. data/README.md +5 -5
  5. data/assets/repo-social-preview.odg +0 -0
  6. data/assets/repo-social-preview.xcf +0 -0
  7. data/ext/wxruby3/include/wxRubyApp.h +58 -45
  8. data/ext/wxruby3/include/wxruby-runtime.h +78 -1
  9. data/ext/wxruby3/swig/common.i +2 -2
  10. data/ext/wxruby3/swig/custom/director.swg +2 -2
  11. data/ext/wxruby3/swig/custom/rubyprimtypes.swg +59 -15
  12. data/ext/wxruby3/swig/custom/rubyrun.swg +4 -0
  13. data/ext/wxruby3/swig/custom/rubytracking.swg +4 -0
  14. data/ext/wxruby3/swig/custom/swiglabels.swg +129 -0
  15. data/ext/wxruby3/swig/custom/swigrun.swg +15 -0
  16. data/ext/wxruby3/swig/custom/typemaps/swigtypemaps.swg +20 -0
  17. data/ext/wxruby3/swig/mark_free_impl.i +154 -88
  18. data/ext/wxruby3/swig/memory_management.i +1 -0
  19. data/ext/wxruby3/swig/wx.i +73 -44
  20. data/lib/wx/aui/events/evt_list.rb +148 -0
  21. data/lib/wx/aui/require.rb +0 -1
  22. data/lib/wx/core/calendar_ctrl.rb +15 -0
  23. data/lib/wx/core/clipboard.rb +9 -13
  24. data/lib/wx/core/config.rb +1 -1
  25. data/lib/wx/core/events/evt_list.rb +1458 -0
  26. data/lib/wx/core/font/encoding.rb +113 -0
  27. data/lib/wx/core/generic_validator.rb +83 -31
  28. data/lib/wx/core/tipwindow.rb +16 -0
  29. data/lib/wx/core/variant.rb +6 -0
  30. data/lib/wx/doc/aui/auitabctrl.rb +35 -0
  31. data/lib/wx/doc/config.rb +2 -2
  32. data/lib/wx/doc/functions.rb +1 -1
  33. data/lib/wx/doc/gen/about_dialog_info.rb +330 -0
  34. data/lib/wx/doc/gen/accelerator.rb +178 -0
  35. data/lib/wx/doc/gen/activity_indicator.rb +83 -0
  36. data/lib/wx/doc/gen/affine_matrix2d.rb +284 -0
  37. data/lib/wx/doc/gen/animation.rb +275 -0
  38. data/lib/wx/doc/gen/animation_ctrl.rb +300 -0
  39. data/lib/wx/doc/gen/any_button.rb +191 -0
  40. data/lib/wx/doc/gen/app.rb +463 -0
  41. data/lib/wx/doc/gen/app_traits.rb +396 -0
  42. data/lib/wx/doc/gen/art_provider.rb +605 -0
  43. data/lib/wx/doc/gen/aui/aui_dock_art.rb +455 -0
  44. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +54 -0
  45. data/lib/wx/doc/gen/aui/aui_manager.rb +847 -0
  46. data/lib/wx/doc/gen/aui/aui_manager_event.rb +131 -0
  47. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +180 -0
  48. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +59 -0
  49. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +130 -0
  50. data/lib/wx/doc/gen/aui/aui_notebook.rb +631 -0
  51. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +233 -0
  52. data/lib/wx/doc/gen/aui/aui_pane_info.rb +769 -0
  53. data/lib/wx/doc/gen/aui/aui_tab_art.rb +352 -0
  54. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +14 -0
  55. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +510 -0
  56. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +340 -0
  57. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +244 -0
  58. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +257 -0
  59. data/lib/wx/doc/gen/aui/event_list.rb +179 -0
  60. data/lib/wx/doc/gen/banner_window.rb +124 -0
  61. data/lib/wx/doc/gen/bitmap.rb +731 -0
  62. data/lib/wx/doc/gen/bitmap_button.rb +123 -0
  63. data/lib/wx/doc/gen/bitmap_combo_box.rb +221 -0
  64. data/lib/wx/doc/gen/book_ctrl_base.rb +273 -0
  65. data/lib/wx/doc/gen/book_ctrl_event.rb +66 -0
  66. data/lib/wx/doc/gen/box_sizer.rb +85 -0
  67. data/lib/wx/doc/gen/brush.rb +251 -0
  68. data/lib/wx/doc/gen/busy_info.rb +157 -0
  69. data/lib/wx/doc/gen/button.rb +182 -0
  70. data/lib/wx/doc/gen/calculate_layout_event.rb +62 -0
  71. data/lib/wx/doc/gen/calendar_ctrl.rb +505 -0
  72. data/lib/wx/doc/gen/calendar_date_attr.rb +138 -0
  73. data/lib/wx/doc/gen/calendar_event.rb +147 -0
  74. data/lib/wx/doc/gen/caret.rb +97 -0
  75. data/lib/wx/doc/gen/check_box.rb +175 -0
  76. data/lib/wx/doc/gen/check_list_box.rb +121 -0
  77. data/lib/wx/doc/gen/choice.rb +175 -0
  78. data/lib/wx/doc/gen/choicebook.rb +116 -0
  79. data/lib/wx/doc/gen/client_dc.rb +43 -0
  80. data/lib/wx/doc/gen/clipboard.rb +144 -0
  81. data/lib/wx/doc/gen/collapsible_pane.rb +138 -0
  82. data/lib/wx/doc/gen/collapsible_pane_event.rb +46 -0
  83. data/lib/wx/doc/gen/colour.rb +333 -0
  84. data/lib/wx/doc/gen/colour_dialog.rb +190 -0
  85. data/lib/wx/doc/gen/colour_picker_ctrl.rb +110 -0
  86. data/lib/wx/doc/gen/colour_picker_event.rb +77 -0
  87. data/lib/wx/doc/gen/combo_box.rb +292 -0
  88. data/lib/wx/doc/gen/combo_ctrl.rb +662 -0
  89. data/lib/wx/doc/gen/command_link_button.rb +134 -0
  90. data/lib/wx/doc/gen/config_base.rb +10 -0
  91. data/lib/wx/doc/gen/context_help_button.rb +109 -0
  92. data/lib/wx/doc/gen/control.rb +277 -0
  93. data/lib/wx/doc/gen/control_with_items.rb +253 -0
  94. data/lib/wx/doc/gen/core.rb +45 -0
  95. data/lib/wx/doc/gen/credential_entry_dialog.rb +137 -0
  96. data/lib/wx/doc/gen/cursor.rb +193 -0
  97. data/lib/wx/doc/gen/data_format.rb +85 -0
  98. data/lib/wx/doc/gen/data_object.rb +436 -0
  99. data/lib/wx/doc/gen/data_object_simple_base.rb +10 -0
  100. data/lib/wx/doc/gen/date_event.rb +49 -0
  101. data/lib/wx/doc/gen/date_picker_ctrl.rb +161 -0
  102. data/lib/wx/doc/gen/dc.rb +1631 -0
  103. data/lib/wx/doc/gen/dc_overlay.rb +102 -0
  104. data/lib/wx/doc/gen/defs.rb +2802 -0
  105. data/lib/wx/doc/gen/dial_up_event.rb +45 -0
  106. data/lib/wx/doc/gen/dial_up_manager.rb +149 -0
  107. data/lib/wx/doc/gen/dialog.rb +541 -0
  108. data/lib/wx/doc/gen/dir_dialog.rb +164 -0
  109. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +90 -0
  110. data/lib/wx/doc/gen/dir_picker_ctrl.rb +125 -0
  111. data/lib/wx/doc/gen/display.rb +238 -0
  112. data/lib/wx/doc/gen/drag_drop.rb +299 -0
  113. data/lib/wx/doc/gen/drag_image.rb +116 -0
  114. data/lib/wx/doc/gen/editable_list_box.rb +109 -0
  115. data/lib/wx/doc/gen/event.rb +990 -0
  116. data/lib/wx/doc/gen/event_blocker.rb +50 -0
  117. data/lib/wx/doc/gen/event_filter.rb +92 -0
  118. data/lib/wx/doc/gen/event_list.rb +1644 -0
  119. data/lib/wx/doc/gen/events.rb +2809 -0
  120. data/lib/wx/doc/gen/evt_handler.rb +229 -0
  121. data/lib/wx/doc/gen/ext_help_controller.rb +109 -0
  122. data/lib/wx/doc/gen/file_ctrl.rb +231 -0
  123. data/lib/wx/doc/gen/file_ctrl_event.rb +83 -0
  124. data/lib/wx/doc/gen/file_dialog.rb +353 -0
  125. data/lib/wx/doc/gen/file_dialog_custom_control.rb +165 -0
  126. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +158 -0
  127. data/lib/wx/doc/gen/file_dir_picker_event.rb +100 -0
  128. data/lib/wx/doc/gen/file_picker_ctrl.rb +132 -0
  129. data/lib/wx/doc/gen/file_system.rb +232 -0
  130. data/lib/wx/doc/gen/find_dialog_event.rb +126 -0
  131. data/lib/wx/doc/gen/find_replace_data.rb +60 -0
  132. data/lib/wx/doc/gen/find_replace_dialog.rb +58 -0
  133. data/lib/wx/doc/gen/flex_grid_sizer.rb +199 -0
  134. data/lib/wx/doc/gen/font.rb +1379 -0
  135. data/lib/wx/doc/gen/font_data.rb +151 -0
  136. data/lib/wx/doc/gen/font_dialog.rb +88 -0
  137. data/lib/wx/doc/gen/font_picker_ctrl.rb +143 -0
  138. data/lib/wx/doc/gen/font_picker_event.rb +65 -0
  139. data/lib/wx/doc/gen/frame.rb +352 -0
  140. data/lib/wx/doc/gen/fs_file.rb +337 -0
  141. data/lib/wx/doc/gen/functions.rb +10 -0
  142. data/lib/wx/doc/gen/gauge.rb +157 -0
  143. data/lib/wx/doc/gen/gb_sizer_item.rb +68 -0
  144. data/lib/wx/doc/gen/gcdc.rb +46 -0
  145. data/lib/wx/doc/gen/gdi_common.rb +1271 -0
  146. data/lib/wx/doc/gen/gdi_object.rb +31 -0
  147. data/lib/wx/doc/gen/generic_about_dialog.rb +140 -0
  148. data/lib/wx/doc/gen/generic_dir_ctrl.rb +223 -0
  149. data/lib/wx/doc/gen/geometry.rb +661 -0
  150. data/lib/wx/doc/gen/graphics_context.rb +1184 -0
  151. data/lib/wx/doc/gen/graphics_object.rb +750 -0
  152. data/lib/wx/doc/gen/grid/event_list.rb +191 -0
  153. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +40 -0
  154. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +280 -0
  155. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +35 -0
  156. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +37 -0
  157. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +49 -0
  158. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +35 -0
  159. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +46 -0
  160. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +38 -0
  161. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +45 -0
  162. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +40 -0
  163. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +197 -0
  164. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +39 -0
  165. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +44 -0
  166. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +45 -0
  167. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +79 -0
  168. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +46 -0
  169. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +35 -0
  170. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +108 -0
  171. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +35 -0
  172. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +49 -0
  173. data/lib/wx/doc/gen/grid/grid_ctrl.rb +3002 -0
  174. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +95 -0
  175. data/lib/wx/doc/gen/grid/grid_event.rb +129 -0
  176. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +104 -0
  177. data/lib/wx/doc/gen/grid/grid_size_event.rb +85 -0
  178. data/lib/wx/doc/gen/grid/grid_string_table.rb +142 -0
  179. data/lib/wx/doc/gen/grid/grid_table_base.rb +317 -0
  180. data/lib/wx/doc/gen/grid/grid_table_message.rb +81 -0
  181. data/lib/wx/doc/gen/grid_bag_sizer.rb +323 -0
  182. data/lib/wx/doc/gen/grid_sizer.rb +195 -0
  183. data/lib/wx/doc/gen/gui_event_loop.rb +159 -0
  184. data/lib/wx/doc/gen/h_scrolled_window.rb +562 -0
  185. data/lib/wx/doc/gen/header_ctrl.rb +880 -0
  186. data/lib/wx/doc/gen/header_ctrl_event.rb +133 -0
  187. data/lib/wx/doc/gen/help_controller.rb +195 -0
  188. data/lib/wx/doc/gen/help_provider.rb +98 -0
  189. data/lib/wx/doc/gen/html/event_list.rb +38 -0
  190. data/lib/wx/doc/gen/html/html_cell.rb +536 -0
  191. data/lib/wx/doc/gen/html/html_cell_event.rb +69 -0
  192. data/lib/wx/doc/gen/html/html_data_object.rb +42 -0
  193. data/lib/wx/doc/gen/html/html_easy_printing.rb +203 -0
  194. data/lib/wx/doc/gen/html/html_help_controller.rb +340 -0
  195. data/lib/wx/doc/gen/html/html_help_data.rb +159 -0
  196. data/lib/wx/doc/gen/html/html_help_window.rb +258 -0
  197. data/lib/wx/doc/gen/html/html_link_event.rb +41 -0
  198. data/lib/wx/doc/gen/html/html_list_box.rb +346 -0
  199. data/lib/wx/doc/gen/html/html_printout.rb +109 -0
  200. data/lib/wx/doc/gen/html/html_window.rb +461 -0
  201. data/lib/wx/doc/gen/hyperlink_ctrl.rb +311 -0
  202. data/lib/wx/doc/gen/hyperlink_event.rb +44 -0
  203. data/lib/wx/doc/gen/icon.rb +267 -0
  204. data/lib/wx/doc/gen/icon_location.rb +40 -0
  205. data/lib/wx/doc/gen/image.rb +1371 -0
  206. data/lib/wx/doc/gen/image_list.rb +168 -0
  207. data/lib/wx/doc/gen/info_bar.rb +195 -0
  208. data/lib/wx/doc/gen/keyboard_state.rb +140 -0
  209. data/lib/wx/doc/gen/list_box.rb +304 -0
  210. data/lib/wx/doc/gen/list_ctrl.rb +1774 -0
  211. data/lib/wx/doc/gen/list_event.rb +208 -0
  212. data/lib/wx/doc/gen/listbook.rb +116 -0
  213. data/lib/wx/doc/gen/locale.rb +4293 -0
  214. data/lib/wx/doc/gen/log.rb +603 -0
  215. data/lib/wx/doc/gen/mdi_client_window.rb +47 -0
  216. data/lib/wx/doc/gen/mdi_frame.rb +324 -0
  217. data/lib/wx/doc/gen/media_ctrl.rb +269 -0
  218. data/lib/wx/doc/gen/media_event.rb +117 -0
  219. data/lib/wx/doc/gen/memory_dc.rb +174 -0
  220. data/lib/wx/doc/gen/menu.rb +509 -0
  221. data/lib/wx/doc/gen/menu_bar.rb +287 -0
  222. data/lib/wx/doc/gen/menu_item.rb +362 -0
  223. data/lib/wx/doc/gen/message_dialog.rb +238 -0
  224. data/lib/wx/doc/gen/mini_frame.rb +108 -0
  225. data/lib/wx/doc/gen/mirror_dc.rb +22 -0
  226. data/lib/wx/doc/gen/mouse_state.rb +150 -0
  227. data/lib/wx/doc/gen/multi_choice_dialog.rb +80 -0
  228. data/lib/wx/doc/gen/non_owned_window.rb +49 -0
  229. data/lib/wx/doc/gen/notebook.rb +278 -0
  230. data/lib/wx/doc/gen/num_validator.rb +37 -0
  231. data/lib/wx/doc/gen/number_entry_dialog.rb +93 -0
  232. data/lib/wx/doc/gen/object.rb +59 -0
  233. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +395 -0
  234. data/lib/wx/doc/gen/paint_dc.rb +27 -0
  235. data/lib/wx/doc/gen/palette.rb +92 -0
  236. data/lib/wx/doc/gen/panel.rb +127 -0
  237. data/lib/wx/doc/gen/pen.rb +511 -0
  238. data/lib/wx/doc/gen/persistence_manager.rb +135 -0
  239. data/lib/wx/doc/gen/persistent_object.rb +52 -0
  240. data/lib/wx/doc/gen/persistent_window.rb +241 -0
  241. data/lib/wx/doc/gen/pg/event_list.rb +106 -0
  242. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +54 -0
  243. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +292 -0
  244. data/lib/wx/doc/gen/pg/pg_cell.rb +177 -0
  245. data/lib/wx/doc/gen/pg/pg_editor.rb +721 -0
  246. data/lib/wx/doc/gen/pg/pg_multi_button.rb +152 -0
  247. data/lib/wx/doc/gen/pg/pg_properties.rb +2829 -0
  248. data/lib/wx/doc/gen/pg/pg_property.rb +2078 -0
  249. data/lib/wx/doc/gen/pg/pg_validation_info.rb +344 -0
  250. data/lib/wx/doc/gen/pg/property_grid.rb +740 -0
  251. data/lib/wx/doc/gen/pg/property_grid_event.rb +184 -0
  252. data/lib/wx/doc/gen/pg/property_grid_interface.rb +1098 -0
  253. data/lib/wx/doc/gen/pg/property_grid_manager.rb +415 -0
  254. data/lib/wx/doc/gen/pg/property_grid_page.rb +354 -0
  255. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +165 -0
  256. data/lib/wx/doc/gen/picker_base.rb +152 -0
  257. data/lib/wx/doc/gen/platform_info.rb +622 -0
  258. data/lib/wx/doc/gen/popup_window.rb +107 -0
  259. data/lib/wx/doc/gen/progress_dialog.rb +100 -0
  260. data/lib/wx/doc/gen/property_sheet_dialog.rb +216 -0
  261. data/lib/wx/doc/gen/prt/event_list.rb +17 -0
  262. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +44 -0
  263. data/lib/wx/doc/gen/prt/post_script_dc.rb +30 -0
  264. data/lib/wx/doc/gen/prt/preview_frame.rb +78 -0
  265. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +151 -0
  266. data/lib/wx/doc/gen/prt/print_data.rb +804 -0
  267. data/lib/wx/doc/gen/prt/print_dialog.rb +55 -0
  268. data/lib/wx/doc/gen/prt/printer.rb +518 -0
  269. data/lib/wx/doc/gen/prt/printer_dc.rb +37 -0
  270. data/lib/wx/doc/gen/query_layout_info_event.rb +106 -0
  271. data/lib/wx/doc/gen/radio_box.rb +306 -0
  272. data/lib/wx/doc/gen/radio_button.rb +159 -0
  273. data/lib/wx/doc/gen/rbn/event_list.rb +136 -0
  274. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +1132 -0
  275. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +308 -0
  276. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +45 -0
  277. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +458 -0
  278. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +63 -0
  279. data/lib/wx/doc/gen/rbn/ribbon_control.rb +143 -0
  280. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +229 -0
  281. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +55 -0
  282. data/lib/wx/doc/gen/rbn/ribbon_page.rb +174 -0
  283. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +270 -0
  284. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +45 -0
  285. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +360 -0
  286. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +42 -0
  287. data/lib/wx/doc/gen/rearrange_ctrl.rb +78 -0
  288. data/lib/wx/doc/gen/rearrange_list.rb +123 -0
  289. data/lib/wx/doc/gen/region.rb +380 -0
  290. data/lib/wx/doc/gen/region_iterator.rb +76 -0
  291. data/lib/wx/doc/gen/rich_tool_tip.rb +154 -0
  292. data/lib/wx/doc/gen/rtc/event_list.rb +125 -0
  293. data/lib/wx/doc/gen/rtc/rich_text_box.rb +445 -0
  294. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +1188 -0
  295. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +41 -0
  296. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +538 -0
  297. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +2103 -0
  298. data/lib/wx/doc/gen/rtc/rich_text_event.rb +173 -0
  299. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +181 -0
  300. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +319 -0
  301. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +193 -0
  302. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +102 -0
  303. data/lib/wx/doc/gen/rtc/rich_text_image.rb +337 -0
  304. data/lib/wx/doc/gen/rtc/rich_text_object.rb +2922 -0
  305. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +1240 -0
  306. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +258 -0
  307. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +344 -0
  308. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +227 -0
  309. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +59 -0
  310. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +169 -0
  311. data/lib/wx/doc/gen/sash_event.rb +147 -0
  312. data/lib/wx/doc/gen/sash_layout_window.rb +232 -0
  313. data/lib/wx/doc/gen/sash_window.rb +171 -0
  314. data/lib/wx/doc/gen/scaled_dc.rb +10 -0
  315. data/lib/wx/doc/gen/screen_dc.rb +30 -0
  316. data/lib/wx/doc/gen/scroll_bar.rb +204 -0
  317. data/lib/wx/doc/gen/scrolled_canvas.rb +410 -0
  318. data/lib/wx/doc/gen/scrolled_control.rb +410 -0
  319. data/lib/wx/doc/gen/scrolled_window.rb +430 -0
  320. data/lib/wx/doc/gen/search_ctrl.rb +159 -0
  321. data/lib/wx/doc/gen/secret_store.rb +116 -0
  322. data/lib/wx/doc/gen/simplebook.rb +110 -0
  323. data/lib/wx/doc/gen/single_choice_dialog.rb +89 -0
  324. data/lib/wx/doc/gen/sizer.rb +945 -0
  325. data/lib/wx/doc/gen/sizer_item.rb +244 -0
  326. data/lib/wx/doc/gen/slider.rb +342 -0
  327. data/lib/wx/doc/gen/spin_button.rb +157 -0
  328. data/lib/wx/doc/gen/spin_ctrl.rb +231 -0
  329. data/lib/wx/doc/gen/spin_ctrl_double.rb +192 -0
  330. data/lib/wx/doc/gen/spin_double_event.rb +55 -0
  331. data/lib/wx/doc/gen/spin_event.rb +51 -0
  332. data/lib/wx/doc/gen/splash_screen.rb +113 -0
  333. data/lib/wx/doc/gen/splitter_event.rb +99 -0
  334. data/lib/wx/doc/gen/splitter_window.rb +498 -0
  335. data/lib/wx/doc/gen/static_bitmap.rb +256 -0
  336. data/lib/wx/doc/gen/static_box.rb +180 -0
  337. data/lib/wx/doc/gen/static_box_sizer.rb +85 -0
  338. data/lib/wx/doc/gen/static_line.rb +83 -0
  339. data/lib/wx/doc/gen/static_text.rb +127 -0
  340. data/lib/wx/doc/gen/status_bar.rb +290 -0
  341. data/lib/wx/doc/gen/stc/event_list.rb +221 -0
  342. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +4474 -0
  343. data/lib/wx/doc/gen/stc/styled_text_event.rb +8762 -0
  344. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +129 -0
  345. data/lib/wx/doc/gen/svg_file_dc.rb +164 -0
  346. data/lib/wx/doc/gen/system_options.rb +129 -0
  347. data/lib/wx/doc/gen/system_settings.rb +507 -0
  348. data/lib/wx/doc/gen/task_bar_icon.rb +127 -0
  349. data/lib/wx/doc/gen/task_bar_icon_event.rb +88 -0
  350. data/lib/wx/doc/gen/text_attr.rb +756 -0
  351. data/lib/wx/doc/gen/text_ctrl.rb +1033 -0
  352. data/lib/wx/doc/gen/text_entry.rb +441 -0
  353. data/lib/wx/doc/gen/text_entry_dialog.rb +220 -0
  354. data/lib/wx/doc/gen/text_validator.rb +245 -0
  355. data/lib/wx/doc/gen/time_picker_ctrl.rb +128 -0
  356. data/lib/wx/doc/gen/timer.rb +119 -0
  357. data/lib/wx/doc/gen/timer_event.rb +68 -0
  358. data/lib/wx/doc/gen/tip_provider.rb +63 -0
  359. data/lib/wx/doc/gen/tip_window.rb +51 -0
  360. data/lib/wx/doc/gen/toggle_button.rb +182 -0
  361. data/lib/wx/doc/gen/tool_bar.rb +890 -0
  362. data/lib/wx/doc/gen/tool_tip.rb +86 -0
  363. data/lib/wx/doc/gen/toolbook.rb +118 -0
  364. data/lib/wx/doc/gen/top_level_window.rb +497 -0
  365. data/lib/wx/doc/gen/tree_ctrl.rb +1052 -0
  366. data/lib/wx/doc/gen/tree_event.rb +127 -0
  367. data/lib/wx/doc/gen/treebook.rb +180 -0
  368. data/lib/wx/doc/gen/ui_action_simulator.rb +109 -0
  369. data/lib/wx/doc/gen/utils.rb +273 -0
  370. data/lib/wx/doc/gen/v_list_box.rb +272 -0
  371. data/lib/wx/doc/gen/v_scrolled_canvas.rb +195 -0
  372. data/lib/wx/doc/gen/v_scrolled_window.rb +191 -0
  373. data/lib/wx/doc/gen/validator.rb +68 -0
  374. data/lib/wx/doc/gen/variant.rb +294 -0
  375. data/lib/wx/doc/gen/window.rb +2917 -0
  376. data/lib/wx/doc/gen/window_dc.rb +38 -0
  377. data/lib/wx/doc/gen/window_disabler.rb +30 -0
  378. data/lib/wx/doc/gen/with_images.rb +84 -0
  379. data/lib/wx/doc/gen/wizard.rb +257 -0
  380. data/lib/wx/doc/gen/wizard_event.rb +113 -0
  381. data/lib/wx/doc/gen/wizard_page.rb +65 -0
  382. data/lib/wx/doc/gen/wizard_page_simple.rb +88 -0
  383. data/lib/wx/doc/gen/wrap_sizer.rb +79 -0
  384. data/lib/wx/doc/gen/xml_node.rb +316 -0
  385. data/lib/wx/doc/gen/xml_resource.rb +320 -0
  386. data/lib/wx/doc/generic_validator.rb +5 -0
  387. data/lib/wx/doc/pg/pg_property.rb +5 -0
  388. data/lib/wx/doc/tip_window.rb +18 -6
  389. data/lib/wx/doc/variant.rb +30 -0
  390. data/lib/wx/grid/events/evt_list.rb +166 -0
  391. data/lib/wx/html/events/evt_list.rb +27 -0
  392. data/lib/wx/html/simple_html_listbox.rb +46 -33
  393. data/lib/wx/keyword_defs.rb +9 -0
  394. data/lib/wx/pg/events/evt_list.rb +73 -0
  395. data/lib/wx/pg/pg_property.rb +85 -52
  396. data/lib/wx/pg/property_grid_interface.rb +12 -2
  397. data/lib/wx/rbn/events/evt_list.rb +102 -0
  398. data/lib/wx/rtc/events/evt_list.rb +98 -0
  399. data/lib/wx/rtc/ext/rich_text_ctrl.rb +24 -0
  400. data/lib/wx/stc/events/evt_list.rb +178 -0
  401. data/lib/wx/version.rb +1 -1
  402. data/lib/wx/wxruby/cmd/setup.rb +6 -0
  403. data/rakelib/configure.rb +9 -0
  404. data/rakelib/gem.rake +84 -66
  405. data/rakelib/gem.rb +4 -20
  406. data/rakelib/lib/config/linux.rb +1 -1
  407. data/rakelib/lib/config/macosx.rb +15 -1
  408. data/rakelib/lib/config/pkgman/linux.rb +7 -2
  409. data/rakelib/lib/config/unixish.rb +3 -3
  410. data/rakelib/lib/config.rb +19 -8
  411. data/rakelib/lib/core/include/swigdirector.inc +3 -3
  412. data/rakelib/lib/core/include/swigrubyerrors.inc +4 -8
  413. data/rakelib/lib/core/include/swigrubyrun.inc +20 -4
  414. data/rakelib/lib/core/include/swigrun.inc +189 -0
  415. data/rakelib/lib/core/package.rb +3 -1
  416. data/rakelib/lib/core/spec.rb +1 -1
  417. data/rakelib/lib/director/accelerator.rb +1 -1
  418. data/rakelib/lib/director/animation.rb +1 -0
  419. data/rakelib/lib/director/app_traits.rb +1 -1
  420. data/rakelib/lib/director/aui_manager.rb +21 -14
  421. data/rakelib/lib/director/aui_mdi_child_frame.rb +2 -0
  422. data/rakelib/lib/director/aui_mdi_parent_frame.rb +4 -0
  423. data/rakelib/lib/director/aui_notebook.rb +20 -3
  424. data/rakelib/lib/director/aui_tab_ctrl.rb +64 -106
  425. data/rakelib/lib/director/bitmap_combobox.rb +4 -2
  426. data/rakelib/lib/director/calendar_ctrl.rb +72 -14
  427. data/rakelib/lib/director/clipboard.rb +2 -0
  428. data/rakelib/lib/director/data_object.rb +15 -7
  429. data/rakelib/lib/director/date_picker_ctrl.rb +4 -1
  430. data/rakelib/lib/director/display.rb +81 -0
  431. data/rakelib/lib/director/event.rb +33 -16
  432. data/rakelib/lib/director/event_handler.rb +27 -2
  433. data/rakelib/lib/director/functions.rb +9 -0
  434. data/rakelib/lib/director/geometry.rb +5 -0
  435. data/rakelib/lib/director/grid_ctrl.rb +123 -28
  436. data/rakelib/lib/director/help_provider.rb +1 -1
  437. data/rakelib/lib/director/html_listbox.rb +30 -4
  438. data/rakelib/lib/director/hvscrolled.rb +154 -0
  439. data/rakelib/lib/director/image_list.rb +1 -0
  440. data/rakelib/lib/director/mdi_frame.rb +4 -0
  441. data/rakelib/lib/director/menu.rb +56 -15
  442. data/rakelib/lib/director/menu_bar.rb +62 -0
  443. data/rakelib/lib/director/menu_item.rb +7 -1
  444. data/rakelib/lib/director/num_validator.rb +27 -0
  445. data/rakelib/lib/director/numeric_property_validator.rb +9 -0
  446. data/rakelib/lib/director/persistent_window.rb +16 -0
  447. data/rakelib/lib/director/pgproperty.rb +3 -2
  448. data/rakelib/lib/director/popup_window.rb +2 -0
  449. data/rakelib/lib/director/preview_frame.rb +29 -6
  450. data/rakelib/lib/director/printer.rb +59 -5
  451. data/rakelib/lib/director/property_grid.rb +37 -18
  452. data/rakelib/lib/director/property_grid_interface.rb +10 -8
  453. data/rakelib/lib/director/property_grid_manager.rb +99 -39
  454. data/rakelib/lib/director/property_grid_page.rb +60 -0
  455. data/rakelib/lib/director/rich_tooltip.rb +22 -0
  456. data/rakelib/lib/director/richtext_ctrl.rb +5 -0
  457. data/rakelib/lib/director/richtext_object.rb +13 -4
  458. data/rakelib/lib/director/richtext_style_listbox.rb +11 -2
  459. data/rakelib/lib/director/scrolled_t.rb +3 -0
  460. data/rakelib/lib/director/searchctrl.rb +1 -0
  461. data/rakelib/lib/director/task_bar_icon.rb +14 -8
  462. data/rakelib/lib/director/text_validator.rb +9 -0
  463. data/rakelib/lib/director/tip_window.rb +117 -6
  464. data/rakelib/lib/director/tool_bar.rb +6 -0
  465. data/rakelib/lib/director/top_level_window.rb +0 -1
  466. data/rakelib/lib/director/utils.rb +3 -1
  467. data/rakelib/lib/director/validator.rb +12 -0
  468. data/rakelib/lib/director/variant.rb +64 -20
  469. data/rakelib/lib/director/vlistbox.rb +29 -22
  470. data/rakelib/lib/director/window.rb +12 -2
  471. data/rakelib/lib/director/xml_resource.rb +6 -0
  472. data/rakelib/lib/generate/doc/aui_manager.yaml +1 -1
  473. data/rakelib/lib/generate/doc/rich_tool_tip.yaml +26 -0
  474. data/rakelib/lib/generate/doc.rb +12 -7
  475. data/rakelib/lib/generate/interface.rb +16 -1
  476. data/rakelib/lib/specs/interfaces.rb +6 -2
  477. data/rakelib/lib/swig_runner.rb +12 -12
  478. data/rakelib/lib/typemap/aui_tabctrl.rb +46 -0
  479. data/rakelib/lib/typemap/common.rb +3 -3
  480. data/rakelib/lib/typemap/print_page_range.rb +32 -8
  481. data/samples/art/wxruby-512x512.png +0 -0
  482. data/samples/calendar/calendar.rb +64 -1
  483. data/samples/dialogs/dialogs.rb +172 -0
  484. data/samples/dialogs/tip.xpm +157 -0
  485. data/samples/drawing/maths_images.rb +1 -1
  486. data/samples/event/event.rb +1 -1
  487. data/samples/printing/printing2.rb +1 -1
  488. data/samples/sampler.rb +26 -8
  489. data/samples/text/textctrl.rb +2 -2
  490. data/samples/treectrl/treectrl.rb +2 -2
  491. data/tests/lib/leaked_process_event_exception_test.rb +1 -1
  492. data/tests/lib/leaked_queued_event_exception_test.rb +1 -1
  493. data/tests/lib/wxapp_runner.rb +31 -41
  494. data/tests/lib/wxframe_runner.rb +23 -11
  495. data/tests/lib/wxrb_test.rb +58 -0
  496. data/tests/test_app_event_filter.rb +1 -1
  497. data/tests/test_app_exit_exception.rb +3 -3
  498. data/tests/test_app_init_exception.rb +3 -3
  499. data/tests/test_app_traits.rb +24 -21
  500. data/tests/test_art.rb +7 -7
  501. data/tests/test_art_provider.rb +1 -1
  502. data/tests/test_basic.rb +2 -2
  503. data/tests/test_book_controls.rb +1 -1
  504. data/tests/test_box_sizer.rb +1 -1
  505. data/tests/test_clipboard.rb +5 -5
  506. data/tests/test_combo_ctrl.rb +2 -2
  507. data/tests/test_config.rb +11 -1
  508. data/tests/test_dc.rb +1 -1
  509. data/tests/test_dialog.rb +1 -1
  510. data/tests/test_event_handling.rb +1 -1
  511. data/tests/test_events.rb +1 -1
  512. data/tests/test_exceptions.rb +2 -2
  513. data/tests/test_ext_controls.rb +10 -10
  514. data/tests/test_file_dialog.rb +1 -1
  515. data/tests/test_font.rb +1 -1
  516. data/tests/test_gdi_object.rb +1 -1
  517. data/tests/test_geometry.rb +2 -2
  518. data/tests/test_grid_sizer.rb +2 -2
  519. data/tests/test_intl.rb +1 -1
  520. data/tests/test_item_data.rb +12 -12
  521. data/tests/test_list_ctrl.rb +1 -1
  522. data/tests/test_log.rb +2 -2
  523. data/tests/test_media_ctrl.rb +1 -1
  524. data/tests/test_menu.rb +114 -43
  525. data/tests/test_proof_check.rb +1 -1
  526. data/tests/test_propgrid.rb +857 -0
  527. data/tests/test_richtext.rb +10 -24
  528. data/tests/test_secret_store.rb +1 -1
  529. data/tests/test_sizer.rb +1 -1
  530. data/tests/test_std_controls.rb +8 -8
  531. data/tests/test_styled_text_ctrl.rb +1 -1
  532. data/tests/test_timer.rb +1 -1
  533. data/tests/test_tree_ctrl.rb +1 -1
  534. data/tests/test_validators.rb +79 -36
  535. data/tests/test_variant.rb +1 -1
  536. data/tests/test_window.rb +11 -11
  537. data/tests/testapp.rb +2 -2
  538. data/tests/testapp_noframe.rb +2 -2
  539. metadata +402 -12
  540. data/lib/wx/aui/aui_tab_ctrl.rb +0 -18
  541. data/rakelib/lib/director/hvscrolled_window.rb +0 -140
@@ -0,0 +1,4474 @@
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
+ module STC
10
+
11
+ # A wxWidgets implementation of the Scintilla source code editing component.
12
+ #
13
+ # As well as features found in standard text editing components, Scintilla includes features especially useful when editing and debugging source code. These include support for syntax styling, error indicators, code completion and call tips.
14
+ # The selection margin can contain markers like those used in debuggers to indicate breakpoints and the current line. Styling choices are more open than with many editors, allowing the use of proportional fonts, bold and italics, multiple foreground and background colours and multiple fonts.
15
+ # {Wx::STC::StyledTextCtrl} is a 1 to 1 mapping of "raw" scintilla interface, whose documentation can be found in the Scintilla website (http://www.scintilla.org/).
16
+ # Please see {Wx::STC::StyledTextEvent} for the documentation of all event types you can use with {Wx::STC::StyledTextCtrl}.
17
+ #
18
+ # ## Index of the member groups
19
+ # Links for quick access to the various categories of {Wx::STC::StyledTextCtrl} functions:
20
+ #
21
+ # - Constructors and related methods
22
+ # - Text retrieval and modification
23
+ # - Searching and replacing
24
+ # - Overtype
25
+ # - Cut copy and paste
26
+ # - Error handling
27
+ # - Undo and Redo
28
+ # - Selection and information
29
+ # - Multiple Selection and Virtual Space
30
+ # - Scrolling and automatic scrolling
31
+ # - White space
32
+ # - Cursor
33
+ # - Mouse capture
34
+ # - Line endings
35
+ # - Words
36
+ # - Styling
37
+ # - Style definition
38
+ # - Caret selection and hotspot styles
39
+ # - Character representations
40
+ # - Margins
41
+ # - Annotations
42
+ # - Other settings
43
+ # - Brace highlighting
44
+ # - Tabs and Indentation Guides
45
+ # - Markers
46
+ # - Indicators
47
+ # - Autocompletion
48
+ # - User lists
49
+ # - Call tips
50
+ # - Keyboard commands
51
+ # - Key bindings
52
+ # - Popup edit menu
53
+ # - Macro recording
54
+ # - Printing
55
+ # - Direct access
56
+ # - Multiple views
57
+ # - Background loading and saving
58
+ # - Folding
59
+ # - Line wrapping
60
+ # - Zooming
61
+ # - Long lines
62
+ # - Lexer
63
+ # - Event related items
64
+ # - Deprecated items
65
+ # - Additional {Wx::STC::StyledTextCtrl} methods
66
+ # - Raw variants
67
+ # - Text entry methods
68
+ # - Text area methods
69
+ #
70
+ # Category: Scintilla Text Editor
71
+ # @see Wx::STC::StyledTextEvent
72
+ # @see Wx::StyledTextCtrlMiniMap
73
+ #
74
+ #
75
+ # @wxrb_require USE_STC
76
+ class StyledTextCtrl < Control
77
+
78
+ include Wx::TextEntry
79
+
80
+ # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STC_NAME_STR)
81
+ # Ctor.
82
+ # @param parent [Wx::Window]
83
+ # @param id [Integer]
84
+ # @param pos [Array(Integer, Integer), Wx::Point]
85
+ # @param size [Array(Integer, Integer), Wx::Size]
86
+ # @param style [Integer]
87
+ # @param name [String]
88
+ # @return [Wx::STC::StyledTextCtrl]
89
+ # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STC_NAME_STR, &block)
90
+ # Ctor.
91
+ # @param parent [Wx::Window]
92
+ # @param id [Integer]
93
+ # @param pos [Array(Integer, Integer), Wx::Point]
94
+ # @param size [Array(Integer, Integer), Wx::Size]
95
+ # @param style [Integer]
96
+ # @param name [String]
97
+ # @yieldparam [Wx::STC::StyledTextCtrl] win new instance
98
+ # @return [Wx::STC::StyledTextCtrl]
99
+ # @overload initialize()
100
+ # Default ctor.
101
+ # @return [Wx::STC::StyledTextCtrl]
102
+ def initialize(*args) end
103
+
104
+ # Create the UI elements for a STC that was created with the default ctor.
105
+ #
106
+ # (For 2-phase create.)
107
+ # @param parent [Wx::Window]
108
+ # @param id [Integer]
109
+ # @param pos [Array(Integer, Integer), Wx::Point]
110
+ # @param size [Array(Integer, Integer), Wx::Size]
111
+ # @param style [Integer]
112
+ # @param name [String]
113
+ # @return [Boolean]
114
+ def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STC_NAME_STR) end
115
+
116
+ # Add text to the document at current position.
117
+ # @param text [String]
118
+ # @return [void]
119
+ def add_text(text) end
120
+
121
+ # Insert string at a position.
122
+ # @param pos [Integer]
123
+ # @param text [String]
124
+ # @return [void]
125
+ def insert_text(pos, text) end
126
+
127
+ # Change the text that is being inserted in response to {Wx::STC::STC_MOD_INSERTCHECK}.
128
+ # @param length [Integer]
129
+ # @param text [String]
130
+ # @return [void]
131
+ def change_insertion(length, text) end
132
+
133
+ # Delete all text in the document.
134
+ # @return [void]
135
+ def clear_all; end
136
+
137
+ # Delete a range of text in the document.
138
+ # @param start [Integer]
139
+ # @param lengthDelete [Integer]
140
+ # @return [void]
141
+ def delete_range(start, lengthDelete) end
142
+
143
+ # Set all style bytes to 0, remove all folding information.
144
+ # @return [void]
145
+ def clear_document_style; end
146
+
147
+ # Returns the character byte at the position.
148
+ # @param pos [Integer]
149
+ # @return [Integer]
150
+ def get_char_at(pos) end
151
+ alias_method :char_at, :get_char_at
152
+
153
+ # Returns the style byte at the position.
154
+ # @param pos [Integer]
155
+ # @return [Integer]
156
+ def get_style_at(pos) end
157
+ alias_method :style_at, :get_style_at
158
+
159
+ # Remember the current position in the undo history as the position at which the document was saved.
160
+ # @return [void]
161
+ def set_save_point; end
162
+
163
+ # In read-only mode?
164
+ # @return [Boolean]
165
+ def get_read_only; end
166
+ alias_method :read_only, :get_read_only
167
+
168
+ # Retrieve the contents of a line.
169
+ # @param line [Integer]
170
+ # @return [String]
171
+ def get_line(line) end
172
+ alias_method :line, :get_line
173
+
174
+ # Retrieve a range of text.
175
+ # @param startPos [Integer]
176
+ # @param endPos [Integer]
177
+ # @return [String]
178
+ def get_text_range(startPos, endPos) end
179
+ alias_method :text_range, :get_text_range
180
+
181
+ # Replace the selected text with the argument text.
182
+ # @param text [String]
183
+ # @return [void]
184
+ def replace_selection(text) end
185
+
186
+ # Set to read only or read write.
187
+ # @param readOnly [Boolean]
188
+ # @return [void]
189
+ def set_read_only(readOnly) end
190
+ alias_method :read_only=, :set_read_only
191
+
192
+ # Replace the contents of the document with the argument text.
193
+ # @param text [String]
194
+ # @return [void]
195
+ def set_text(text) end
196
+ alias_method :text=, :set_text
197
+
198
+ # Retrieve all the text in the document.
199
+ # @return [String]
200
+ def get_text; end
201
+ alias_method :text, :get_text
202
+
203
+ # Append a string to the end of the document without changing the selection.
204
+ # @param text [String]
205
+ # @return [void]
206
+ def append_text(text) end
207
+
208
+ # Enlarge the document to a particular size of text bytes.
209
+ # @param bytes [Integer]
210
+ # @return [void]
211
+ def allocate(bytes) end
212
+
213
+ # Release all extended (>255) style numbers.
214
+ # @return [void]
215
+ def release_all_extended_styles; end
216
+
217
+ # Allocate some extended (>255) style numbers and return the start of the range.
218
+ # @param numberStyles [Integer]
219
+ # @return [Integer]
220
+ def allocate_extended_styles(numberStyles) end
221
+
222
+ # Find some text in the document.
223
+ #
224
+ # The position (starting from zero) in the document at which the text was found or {Wx::STC::STC_INVALID_POSITION} if the search fails.
225
+ #
226
+ # <div class="wxrb-remark">
227
+ # <b>Remark:</b>
228
+ # <p>A backwards search can be performed by setting minPos to be greater than maxPos.
229
+ # </p>
230
+ # </div>
231
+ # @param minPos [Integer] The position (starting from zero) in the document at which to begin the search
232
+ # @param maxPos [Integer] The last position (starting from zero) in the document to which the search will be restricted.
233
+ # @param text [String] The text to search for.
234
+ # @param flags [Integer] (Optional) The search flags. This should be a bit list containing one or more of the wxSTC_FIND_* constants.
235
+ # @return [Array(Integer,Integer)]
236
+ def find_text(minPos, maxPos, text, flags=0) end
237
+
238
+ # Sets the position that starts the target which is used for updating the document without affecting the scroll position.
239
+ # @param start [Integer]
240
+ # @return [void]
241
+ def set_target_start(start) end
242
+ alias_method :target_start=, :set_target_start
243
+
244
+ # Get the position that starts the target.
245
+ # @return [Integer]
246
+ def get_target_start; end
247
+ alias_method :target_start, :get_target_start
248
+
249
+ # Sets the position that ends the target which is used for updating the document without affecting the scroll position.
250
+ # @param end_ [Integer]
251
+ # @return [void]
252
+ def set_target_end(end_) end
253
+ alias_method :target_end=, :set_target_end
254
+
255
+ # Get the position that ends the target.
256
+ # @return [Integer]
257
+ def get_target_end; end
258
+ alias_method :target_end, :get_target_end
259
+
260
+ # Sets both the start and end of the target in one call.
261
+ # @param start [Integer]
262
+ # @param end_ [Integer]
263
+ # @return [void]
264
+ def set_target_range(start, end_) end
265
+
266
+ # Retrieve the text in the target.
267
+ # @return [String]
268
+ def get_target_text; end
269
+ alias_method :target_text, :get_target_text
270
+
271
+ # Make the target range start and end be the same as the selection range start and end.
272
+ # @return [void]
273
+ def target_from_selection; end
274
+
275
+ # Sets the target to the whole document.
276
+ # @return [void]
277
+ def target_whole_document; end
278
+
279
+ # Replace the target text with the argument text.
280
+ #
281
+ # Text is counted so it can contain NULs. Returns the length of the replacement text.
282
+ # @param text [String]
283
+ # @return [Integer]
284
+ def replace_target(text) end
285
+
286
+ # Replace the target text with the argument text after \d processing.
287
+ #
288
+ # Text is counted so it can contain NULs. Looks for \d where d is between 1 and 9 and replaces these with the strings matched in the last search operation which were surrounded by \( and \). Returns the length of the replacement text including any change caused by processing the \d patterns.
289
+ # @param text [String]
290
+ # @return [Integer]
291
+ def replace_target_re(text) end
292
+
293
+ # Search for a counted string in the target and set the target to the found range.
294
+ #
295
+ # Text is counted so it can contain NULs. Returns start of found range or -1 for failure in which case target is not moved.
296
+ # @param text [String]
297
+ # @return [Integer]
298
+ def search_in_target(text) end
299
+
300
+ # Set the search flags used by SearchInTarget.
301
+ #
302
+ # The input should be a bit list containing one or more of the wxSTC_FIND_* constants.
303
+ # @param searchFlags [Integer]
304
+ # @return [void]
305
+ def set_search_flags(searchFlags) end
306
+ alias_method :search_flags=, :set_search_flags
307
+
308
+ # Get the search flags used by SearchInTarget.
309
+ #
310
+ # The return value will be a bit list containing one or more of the wxSTC_FIND_* constants.
311
+ # @return [Integer]
312
+ def get_search_flags; end
313
+ alias_method :search_flags, :get_search_flags
314
+
315
+ # Retrieve the value of a tag from a regular expression search.
316
+ # @param tagNumber [Integer]
317
+ # @return [String]
318
+ def get_tag(tagNumber) end
319
+ alias_method :tag, :get_tag
320
+
321
+ # Sets the current caret position to be the search anchor.
322
+ # @return [void]
323
+ def search_anchor; end
324
+
325
+ # Find some text starting at the search anchor.
326
+ #
327
+ # Does not ensure the selection is visible.
328
+ # @param searchFlags [Integer]
329
+ # @param text [String]
330
+ # @return [Integer]
331
+ def search_next(searchFlags, text) end
332
+
333
+ # Find some text starting at the search anchor and moving backwards.
334
+ #
335
+ # Does not ensure the selection is visible.
336
+ # @param searchFlags [Integer]
337
+ # @param text [String]
338
+ # @return [Integer]
339
+ def search_prev(searchFlags, text) end
340
+
341
+ # Set to overtype (true) or insert mode.
342
+ # @param overType [Boolean]
343
+ # @return [void]
344
+ def set_overtype(overType) end
345
+ alias_method :overtype=, :set_overtype
346
+
347
+ # Returns true if overtype mode is active otherwise false is returned.
348
+ # @return [Boolean]
349
+ def get_overtype; end
350
+ alias_method :overtype, :get_overtype
351
+
352
+ # Will a paste succeed?
353
+ # @return [Boolean]
354
+ def can_paste; end
355
+ alias_method :can_paste?, :can_paste
356
+
357
+ # Cut the selection to the clipboard.
358
+ # @return [void]
359
+ def cut; end
360
+
361
+ # Copy the selection to the clipboard.
362
+ # @return [void]
363
+ def copy; end
364
+
365
+ # Paste the contents of the clipboard into the document replacing the selection.
366
+ # @return [void]
367
+ def paste; end
368
+
369
+ # Clear the selection.
370
+ # @return [void]
371
+ def clear; end
372
+
373
+ # Copy a range of text to the clipboard.
374
+ #
375
+ # Positions are clipped into the document.
376
+ # @param start [Integer]
377
+ # @param end_ [Integer]
378
+ # @return [void]
379
+ def copy_range(start, end_) end
380
+
381
+ # Copy argument text to the clipboard.
382
+ # @param length [Integer]
383
+ # @param text [String]
384
+ # @return [void]
385
+ def copy_text(length, text) end
386
+
387
+ # Enable/Disable convert-on-paste for line endings.
388
+ # @param convert [Boolean]
389
+ # @return [void]
390
+ def set_paste_convert_endings(convert) end
391
+ alias_method :paste_convert_endings=, :set_paste_convert_endings
392
+
393
+ # Get convert-on-paste setting.
394
+ # @return [Boolean]
395
+ def get_paste_convert_endings; end
396
+ alias_method :paste_convert_endings, :get_paste_convert_endings
397
+
398
+ # Copy the selection, if selection empty copy the line with the caret.
399
+ # @return [void]
400
+ def copy_allow_line; end
401
+
402
+ # Change error status - 0 = OK.
403
+ #
404
+ # The input should be one of the wxSTC_STATUS_* constants.
405
+ # @param status [Integer]
406
+ # @return [void]
407
+ def set_status(status) end
408
+ alias_method :status=, :set_status
409
+
410
+ # Get error status.
411
+ #
412
+ # The return value will be one of the wxSTC_STATUS_* constants.
413
+ # @return [Integer]
414
+ def get_status; end
415
+ alias_method :status, :get_status
416
+
417
+ # Redoes the next action on the undo history.
418
+ # @return [void]
419
+ def redo_; end
420
+
421
+ # Choose between collecting actions into the undo history and discarding them.
422
+ # @param collectUndo [Boolean]
423
+ # @return [void]
424
+ def set_undo_collection(collectUndo) end
425
+ alias_method :undo_collection=, :set_undo_collection
426
+
427
+ # Are there any redoable actions in the undo history?
428
+ # @return [Boolean]
429
+ def can_redo; end
430
+ alias_method :can_redo?, :can_redo
431
+
432
+ # Is undo history being collected?
433
+ # @return [Boolean]
434
+ def get_undo_collection; end
435
+ alias_method :undo_collection, :get_undo_collection
436
+
437
+ # Start a sequence of actions that is undone and redone as a unit.
438
+ #
439
+ # May be nested.
440
+ # @return [void]
441
+ def begin_undo_action; end
442
+
443
+ # End a sequence of actions that is undone and redone as a unit.
444
+ # @return [void]
445
+ def end_undo_action; end
446
+
447
+ # Are there any undoable actions in the undo history?
448
+ # @return [Boolean]
449
+ def can_undo; end
450
+ alias_method :can_undo?, :can_undo
451
+
452
+ # Delete the undo history.
453
+ # @return [void]
454
+ def empty_undo_buffer; end
455
+
456
+ # Undo one action in the undo history.
457
+ # @return [void]
458
+ def undo; end
459
+
460
+ # Add a container action to the undo stack.
461
+ #
462
+ # The flags argument can be either 0 or {Wx::STC::STC_UNDO_MAY_COALESCE}.
463
+ # @param token [Integer]
464
+ # @param flags [Integer]
465
+ # @return [void]
466
+ def add_undo_action(token, flags) end
467
+
468
+ # Returns the number of bytes in the document.
469
+ # @return [Integer]
470
+ def get_length; end
471
+ alias_method :length, :get_length
472
+
473
+ # Returns the position of the caret.
474
+ # @return [Integer]
475
+ def get_current_pos; end
476
+ alias_method :current_pos, :get_current_pos
477
+
478
+ # Returns the position of the opposite end of the selection to the caret.
479
+ # @return [Integer]
480
+ def get_anchor; end
481
+ alias_method :anchor, :get_anchor
482
+
483
+ # Select all the text in the document.
484
+ # @return [void]
485
+ def select_all; end
486
+
487
+ # Find the position from a point within the window.
488
+ # @param pt [Wx::Point]
489
+ # @return [Integer]
490
+ def position_from_point(pt) end
491
+
492
+ # Find the position from a point within the window but return {Wx::STC::STC_INVALID_POSITION} if not close to text.
493
+ # @param x [Integer]
494
+ # @param y [Integer]
495
+ # @return [Integer]
496
+ def position_from_point_close(x, y) end
497
+
498
+ # Set caret to start of a line and ensure it is visible.
499
+ # @param line [Integer]
500
+ # @return [void]
501
+ def goto_line(line) end
502
+
503
+ # Set caret to a position and ensure it is visible.
504
+ # @param caret [Integer]
505
+ # @return [void]
506
+ def goto_pos(caret) end
507
+
508
+ # Set the selection anchor to a position.
509
+ #
510
+ # The anchor is the opposite end of the selection from the caret.
511
+ # @param anchor [Integer]
512
+ # @return [void]
513
+ def set_anchor(anchor) end
514
+ alias_method :anchor=, :set_anchor
515
+
516
+ # Retrieve the text of the line containing the caret.
517
+ #
518
+ # linePos can optionally be passed in to receive the index of the caret on the line.
519
+ # @return [Array(String,Integer)]
520
+ def get_cur_line; end
521
+ alias_method :cur_line, :get_cur_line
522
+
523
+ # Retrieve the column number of a position, taking tab width into account.
524
+ # @param pos [Integer]
525
+ # @return [Integer]
526
+ def get_column(pos) end
527
+ alias_method :column, :get_column
528
+
529
+ # Count characters between two positions.
530
+ # @param start [Integer]
531
+ # @param end_ [Integer]
532
+ # @return [Integer]
533
+ def count_characters(start, end_) end
534
+
535
+ # Get the position after the last visible characters on a line.
536
+ # @param line [Integer]
537
+ # @return [Integer]
538
+ def get_line_end_position(line) end
539
+ alias_method :line_end_position, :get_line_end_position
540
+
541
+ # Sets the position of the caret.
542
+ # @param caret [Integer]
543
+ # @return [void]
544
+ def set_current_pos(caret) end
545
+ alias_method :current_pos=, :set_current_pos
546
+
547
+ # Sets the position that starts the selection - this becomes the anchor.
548
+ # @param anchor [Integer]
549
+ # @return [void]
550
+ def set_selection_start(anchor) end
551
+ alias_method :selection_start=, :set_selection_start
552
+
553
+ # Returns the position at the start of the selection.
554
+ # @return [Integer]
555
+ def get_selection_start; end
556
+ alias_method :selection_start, :get_selection_start
557
+
558
+ # Sets the position that ends the selection - this becomes the caret.
559
+ # @param caret [Integer]
560
+ # @return [void]
561
+ def set_selection_end(caret) end
562
+ alias_method :selection_end=, :set_selection_end
563
+
564
+ # Returns the position at the end of the selection.
565
+ # @return [Integer]
566
+ def get_selection_end; end
567
+ alias_method :selection_end, :get_selection_end
568
+
569
+ # Set caret to a position, while removing any existing selection.
570
+ # @param caret [Integer]
571
+ # @return [void]
572
+ def set_empty_selection(caret) end
573
+ alias_method :empty_selection=, :set_empty_selection
574
+
575
+ # Returns the number of lines in the document.
576
+ #
577
+ # There is always at least one.
578
+ # @return [Integer]
579
+ def get_line_count; end
580
+ alias_method :line_count, :get_line_count
581
+
582
+ # Is the document different from when it was last saved?
583
+ # @return [Boolean]
584
+ def get_modify; end
585
+ alias_method :modify, :get_modify
586
+
587
+ # Retrieve the selected text.
588
+ # @return [String]
589
+ def get_selected_text; end
590
+ alias_method :selected_text, :get_selected_text
591
+
592
+ # Draw the selection either highlighted or in normal (non-highlighted) style.
593
+ # @param hide [Boolean]
594
+ # @return [void]
595
+ def hide_selection(hide) end
596
+
597
+ # Retrieve the point in the window where a position is displayed.
598
+ # @param pos [Integer]
599
+ # @return [Wx::Point]
600
+ def point_from_position(pos) end
601
+
602
+ # Retrieve the line containing a position.
603
+ # @param pos [Integer]
604
+ # @return [Integer]
605
+ def line_from_position(pos) end
606
+
607
+ # Retrieve the position at the start of a line.
608
+ # @param line [Integer]
609
+ # @return [Integer]
610
+ def position_from_line(line) end
611
+
612
+ # Retrieve the number of characters in the document.
613
+ # @return [Integer]
614
+ def get_text_length; end
615
+ alias_method :text_length, :get_text_length
616
+
617
+ # Measure the pixel width of some text in a particular style.
618
+ #
619
+ # Does not handle tab or control characters.
620
+ # @param style [Integer]
621
+ # @param text [String]
622
+ # @return [Integer]
623
+ def text_width(style, text) end
624
+
625
+ # Retrieve the height of a particular line of text in pixels.
626
+ # @param line [Integer]
627
+ # @return [Integer]
628
+ def text_height(line) end
629
+
630
+ # Move the caret inside current view if it's not there already.
631
+ # @return [void]
632
+ def move_caret_inside_view; end
633
+
634
+ # How many characters are on a line, including end of line characters?
635
+ # @param line [Integer]
636
+ # @return [Integer]
637
+ def line_length(line) end
638
+
639
+ # Retrieves the number of lines completely visible.
640
+ # @return [Integer]
641
+ def lines_on_screen; end
642
+
643
+ # Is the selection rectangular?
644
+ #
645
+ # The alternative is the more common stream selection.
646
+ # @return [Boolean]
647
+ def selection_is_rectangle; end
648
+
649
+ # Set the last x chosen value to be the caret x position.
650
+ # @return [void]
651
+ def choose_caret_x; end
652
+
653
+ # Given a valid document position, return the previous position taking code page into account.
654
+ #
655
+ # Returns 0 if passed 0.
656
+ # @param pos [Integer]
657
+ # @return [Integer]
658
+ def position_before(pos) end
659
+
660
+ # Given a valid document position, return the next position taking code page into account.
661
+ #
662
+ # Maximum value returned is the last position in the document.
663
+ # @param pos [Integer]
664
+ # @return [Integer]
665
+ def position_after(pos) end
666
+
667
+ # Given a valid document position, return a position that differs in a number of characters.
668
+ #
669
+ # Returned value is always between 0 and last position in document.
670
+ # @param pos [Integer]
671
+ # @param relative [Integer]
672
+ # @return [Integer]
673
+ def position_relative(pos, relative) end
674
+
675
+ # Set the selection mode to stream ({Wx::STC::STC_SEL_STREAM}) or rectangular ({Wx::STC::STC_SEL_RECTANGLE}/{Wx::STC::STC_SEL_THIN}) or by lines ({Wx::STC::STC_SEL_LINES}).
676
+ # @param selectionMode [Integer]
677
+ # @return [void]
678
+ def set_selection_mode(selectionMode) end
679
+ alias_method :selection_mode=, :set_selection_mode
680
+
681
+ # Get the mode of the current selection.
682
+ #
683
+ # The return value will be one of the wxSTC_SEL_* constants.
684
+ # @return [Integer]
685
+ def get_selection_mode; end
686
+ alias_method :selection_mode, :get_selection_mode
687
+
688
+ # Retrieve the position of the start of the selection at the given line ({Wx::STC::STC_INVALID_POSITION} if no selection on this line).
689
+ # @param line [Integer]
690
+ # @return [Integer]
691
+ def get_line_sel_start_position(line) end
692
+ alias_method :line_sel_start_position, :get_line_sel_start_position
693
+
694
+ # Retrieve the position of the end of the selection at the given line ({Wx::STC::STC_INVALID_POSITION} if no selection on this line).
695
+ # @param line [Integer]
696
+ # @return [Integer]
697
+ def get_line_sel_end_position(line) end
698
+ alias_method :line_sel_end_position, :get_line_sel_end_position
699
+
700
+ # Find the position of a column on a line taking into account tabs and multi-byte characters.
701
+ #
702
+ # If beyond end of line, return line end position.
703
+ # @param line [Integer]
704
+ # @param column [Integer]
705
+ # @return [Integer]
706
+ def find_column(line, column) end
707
+
708
+ # Find the position of a character from a point within the window.
709
+ # @param x [Integer]
710
+ # @param y [Integer]
711
+ # @return [Integer]
712
+ def char_position_from_point(x, y) end
713
+
714
+ # Find the position of a character from a point within the window.
715
+ #
716
+ # Return {Wx::STC::STC_INVALID_POSITION} if not close to text.
717
+ # @param x [Integer]
718
+ # @param y [Integer]
719
+ # @return [Integer]
720
+ def char_position_from_point_close(x, y) end
721
+
722
+ # Set whether switching to rectangular mode while selecting with the mouse is allowed.
723
+ # @param mouseSelectionRectangularSwitch [Boolean]
724
+ # @return [void]
725
+ def set_mouse_selection_rectangular_switch(mouseSelectionRectangularSwitch) end
726
+ alias_method :mouse_selection_rectangular_switch=, :set_mouse_selection_rectangular_switch
727
+
728
+ # Whether switching to rectangular mode while selecting with the mouse is allowed.
729
+ # @return [Boolean]
730
+ def get_mouse_selection_rectangular_switch; end
731
+ alias_method :mouse_selection_rectangular_switch, :get_mouse_selection_rectangular_switch
732
+
733
+ # Move the selected lines up one line, shifting the line above after the selection.
734
+ # @return [void]
735
+ def move_selected_lines_up; end
736
+
737
+ # Move the selected lines down one line, shifting the line below before the selection.
738
+ # @return [void]
739
+ def move_selected_lines_down; end
740
+
741
+ # Change the effect of pasting when there are multiple selections.
742
+ #
743
+ # The input should be one of the wxSTC_MULTIPASTE_* constants.
744
+ # @param multiPaste [Integer]
745
+ # @return [void]
746
+ def set_multi_paste(multiPaste) end
747
+ alias_method :multi_paste=, :set_multi_paste
748
+
749
+ # Retrieve the effect of pasting when there are multiple selections.
750
+ #
751
+ # The return value will be one of the wxSTC_MULTIPASTE_* constants.
752
+ # @return [Integer]
753
+ def get_multi_paste; end
754
+ alias_method :multi_paste, :get_multi_paste
755
+
756
+ # Set whether multiple selections can be made.
757
+ # @param multipleSelection [Boolean]
758
+ # @return [void]
759
+ def set_multiple_selection(multipleSelection) end
760
+ alias_method :multiple_selection=, :set_multiple_selection
761
+
762
+ # Whether multiple selections can be made.
763
+ # @return [Boolean]
764
+ def get_multiple_selection; end
765
+ alias_method :multiple_selection, :get_multiple_selection
766
+
767
+ # Set whether typing can be performed into multiple selections.
768
+ # @param additionalSelectionTyping [Boolean]
769
+ # @return [void]
770
+ def set_additional_selection_typing(additionalSelectionTyping) end
771
+ alias_method :additional_selection_typing=, :set_additional_selection_typing
772
+
773
+ # Whether typing can be performed into multiple selections.
774
+ # @return [Boolean]
775
+ def get_additional_selection_typing; end
776
+ alias_method :additional_selection_typing, :get_additional_selection_typing
777
+
778
+ # Set whether additional carets will blink.
779
+ # @param additionalCaretsBlink [Boolean]
780
+ # @return [void]
781
+ def set_additional_carets_blink(additionalCaretsBlink) end
782
+ alias_method :additional_carets_blink=, :set_additional_carets_blink
783
+
784
+ # Whether additional carets will blink.
785
+ # @return [Boolean]
786
+ def get_additional_carets_blink; end
787
+ alias_method :additional_carets_blink, :get_additional_carets_blink
788
+
789
+ # Set whether additional carets are visible.
790
+ # @param additionalCaretsVisible [Boolean]
791
+ # @return [void]
792
+ def set_additional_carets_visible(additionalCaretsVisible) end
793
+ alias_method :additional_carets_visible=, :set_additional_carets_visible
794
+
795
+ # Whether additional carets are visible.
796
+ # @return [Boolean]
797
+ def get_additional_carets_visible; end
798
+ alias_method :additional_carets_visible, :get_additional_carets_visible
799
+
800
+ # How many selections are there?
801
+ # @return [Integer]
802
+ def get_selections; end
803
+ alias_method :selections, :get_selections
804
+
805
+ # Is every selected range empty?
806
+ # @return [Boolean]
807
+ def get_selection_empty; end
808
+ alias_method :selection_empty, :get_selection_empty
809
+
810
+ # Clear selections to a single empty stream selection.
811
+ # @return [void]
812
+ def clear_selections; end
813
+
814
+ # Add a selection.
815
+ # @param caret [Integer]
816
+ # @param anchor [Integer]
817
+ # @return [void]
818
+ def add_selection(caret, anchor) end
819
+
820
+ # Drop one selection.
821
+ # @param selection [Integer]
822
+ # @return [void]
823
+ def drop_selection_n(selection) end
824
+
825
+ # Set the main selection.
826
+ # @param selection [Integer]
827
+ # @return [void]
828
+ def set_main_selection(selection) end
829
+ alias_method :main_selection=, :set_main_selection
830
+
831
+ # Which selection is the main selection.
832
+ # @return [Integer]
833
+ def get_main_selection; end
834
+ alias_method :main_selection, :get_main_selection
835
+
836
+ # Set the caret position of the nth selection.
837
+ # @param selection [Integer]
838
+ # @param caret [Integer]
839
+ # @return [void]
840
+ def set_selection_n_caret(selection, caret) end
841
+
842
+ # Return the caret position of the nth selection.
843
+ # @param selection [Integer]
844
+ # @return [Integer]
845
+ def get_selection_n_caret(selection) end
846
+ alias_method :selection_n_caret, :get_selection_n_caret
847
+
848
+ # Set the anchor position of the nth selection.
849
+ # @param selection [Integer]
850
+ # @param anchor [Integer]
851
+ # @return [void]
852
+ def set_selection_n_anchor(selection, anchor) end
853
+
854
+ # Return the anchor position of the nth selection.
855
+ # @param selection [Integer]
856
+ # @return [Integer]
857
+ def get_selection_n_anchor(selection) end
858
+ alias_method :selection_n_anchor, :get_selection_n_anchor
859
+
860
+ # Set the virtual space of the caret of the nth selection.
861
+ # @param selection [Integer]
862
+ # @param space [Integer]
863
+ # @return [void]
864
+ def set_selection_n_caret_virtual_space(selection, space) end
865
+
866
+ # Return the virtual space of the caret of the nth selection.
867
+ # @param selection [Integer]
868
+ # @return [Integer]
869
+ def get_selection_n_caret_virtual_space(selection) end
870
+ alias_method :selection_n_caret_virtual_space, :get_selection_n_caret_virtual_space
871
+
872
+ # Set the virtual space of the anchor of the nth selection.
873
+ # @param selection [Integer]
874
+ # @param space [Integer]
875
+ # @return [void]
876
+ def set_selection_n_anchor_virtual_space(selection, space) end
877
+
878
+ # Return the virtual space of the anchor of the nth selection.
879
+ # @param selection [Integer]
880
+ # @return [Integer]
881
+ def get_selection_n_anchor_virtual_space(selection) end
882
+ alias_method :selection_n_anchor_virtual_space, :get_selection_n_anchor_virtual_space
883
+
884
+ # Sets the position that starts the selection - this becomes the anchor.
885
+ # @param selection [Integer]
886
+ # @param anchor [Integer]
887
+ # @return [void]
888
+ def set_selection_n_start(selection, anchor) end
889
+
890
+ # Returns the position at the start of the selection.
891
+ # @param selection [Integer]
892
+ # @return [Integer]
893
+ def get_selection_n_start(selection) end
894
+ alias_method :selection_n_start, :get_selection_n_start
895
+
896
+ # Sets the position that ends the selection - this becomes the currentPosition.
897
+ # @param selection [Integer]
898
+ # @param caret [Integer]
899
+ # @return [void]
900
+ def set_selection_n_end(selection, caret) end
901
+
902
+ # Returns the position at the end of the selection.
903
+ # @param selection [Integer]
904
+ # @return [Integer]
905
+ def get_selection_n_end(selection) end
906
+ alias_method :selection_n_end, :get_selection_n_end
907
+
908
+ # Set the caret position of the rectangular selection.
909
+ # @param caret [Integer]
910
+ # @return [void]
911
+ def set_rectangular_selection_caret(caret) end
912
+ alias_method :rectangular_selection_caret=, :set_rectangular_selection_caret
913
+
914
+ # Return the caret position of the rectangular selection.
915
+ # @return [Integer]
916
+ def get_rectangular_selection_caret; end
917
+ alias_method :rectangular_selection_caret, :get_rectangular_selection_caret
918
+
919
+ # Set the anchor position of the rectangular selection.
920
+ # @param anchor [Integer]
921
+ # @return [void]
922
+ def set_rectangular_selection_anchor(anchor) end
923
+ alias_method :rectangular_selection_anchor=, :set_rectangular_selection_anchor
924
+
925
+ # Return the anchor position of the rectangular selection.
926
+ # @return [Integer]
927
+ def get_rectangular_selection_anchor; end
928
+ alias_method :rectangular_selection_anchor, :get_rectangular_selection_anchor
929
+
930
+ # Set the virtual space of the caret of the rectangular selection.
931
+ # @param space [Integer]
932
+ # @return [void]
933
+ def set_rectangular_selection_caret_virtual_space(space) end
934
+ alias_method :rectangular_selection_caret_virtual_space=, :set_rectangular_selection_caret_virtual_space
935
+
936
+ # Return the virtual space of the caret of the rectangular selection.
937
+ # @return [Integer]
938
+ def get_rectangular_selection_caret_virtual_space; end
939
+ alias_method :rectangular_selection_caret_virtual_space, :get_rectangular_selection_caret_virtual_space
940
+
941
+ # Set the virtual space of the anchor of the rectangular selection.
942
+ # @param space [Integer]
943
+ # @return [void]
944
+ def set_rectangular_selection_anchor_virtual_space(space) end
945
+ alias_method :rectangular_selection_anchor_virtual_space=, :set_rectangular_selection_anchor_virtual_space
946
+
947
+ # Return the virtual space of the anchor of the rectangular selection.
948
+ # @return [Integer]
949
+ def get_rectangular_selection_anchor_virtual_space; end
950
+ alias_method :rectangular_selection_anchor_virtual_space, :get_rectangular_selection_anchor_virtual_space
951
+
952
+ # Set options for virtual space behaviour.
953
+ #
954
+ # The input should be one of the wxSTC_VS_* constants.
955
+ # @param virtualSpaceOptions [Integer]
956
+ # @return [void]
957
+ def set_virtual_space_options(virtualSpaceOptions) end
958
+ alias_method :virtual_space_options=, :set_virtual_space_options
959
+
960
+ # Return options for virtual space behaviour.
961
+ #
962
+ # The return value will be one of the wxSTC_VS_* constants.
963
+ # @return [Integer]
964
+ def get_virtual_space_options; end
965
+ alias_method :virtual_space_options, :get_virtual_space_options
966
+
967
+ # On GTK, allow selecting the modifier key to use for mouse-based rectangular selection.
968
+ #
969
+ # Often the window manager requires Alt+Mouse Drag for moving windows. Valid values are {Wx::STC::STC_KEYMOD_CTRL} (default), {Wx::STC::STC_KEYMOD_ALT}, or {Wx::STC::STC_KEYMOD_SUPER}.
970
+ # @param modifier [Integer]
971
+ # @return [void]
972
+ def set_rectangular_selection_modifier(modifier) end
973
+ alias_method :rectangular_selection_modifier=, :set_rectangular_selection_modifier
974
+
975
+ # Get the modifier key used for rectangular selection.
976
+ #
977
+ # The return value will be a bit list containing one or more of the wxSTC_KEYMOD_* constants.
978
+ # @return [Integer]
979
+ def get_rectangular_selection_modifier; end
980
+ alias_method :rectangular_selection_modifier, :get_rectangular_selection_modifier
981
+
982
+ # Set the foreground colour of additional selections.
983
+ #
984
+ # Must have previously called SetSelFore with non-zero first argument for this to have an effect.
985
+ # @param fore [Wx::Colour,String,Symbol]
986
+ # @return [void]
987
+ def set_additional_sel_foreground(fore) end
988
+ alias_method :additional_sel_foreground=, :set_additional_sel_foreground
989
+
990
+ # Set the background colour of additional selections.
991
+ #
992
+ # Must have previously called SetSelBack with non-zero first argument for this to have an effect.
993
+ # @param back [Wx::Colour,String,Symbol]
994
+ # @return [void]
995
+ def set_additional_sel_background(back) end
996
+ alias_method :additional_sel_background=, :set_additional_sel_background
997
+
998
+ # Set the alpha of the selection.
999
+ # @param alpha [Integer]
1000
+ # @return [void]
1001
+ def set_additional_sel_alpha(alpha) end
1002
+ alias_method :additional_sel_alpha=, :set_additional_sel_alpha
1003
+
1004
+ # Get the alpha of the selection.
1005
+ # @return [Integer]
1006
+ def get_additional_sel_alpha; end
1007
+ alias_method :additional_sel_alpha, :get_additional_sel_alpha
1008
+
1009
+ # Set the foreground colour of additional carets.
1010
+ # @param fore [Wx::Colour,String,Symbol]
1011
+ # @return [void]
1012
+ def set_additional_caret_foreground(fore) end
1013
+ alias_method :additional_caret_foreground=, :set_additional_caret_foreground
1014
+
1015
+ # Get the foreground colour of additional carets.
1016
+ # @return [Wx::Colour]
1017
+ def get_additional_caret_foreground; end
1018
+ alias_method :additional_caret_foreground, :get_additional_caret_foreground
1019
+
1020
+ # Set the main selection to the next selection.
1021
+ # @return [void]
1022
+ def rotate_selection; end
1023
+
1024
+ # Swap that caret and anchor of the main selection.
1025
+ # @return [void]
1026
+ def swap_main_anchor_caret; end
1027
+
1028
+ # Add the next occurrence of the main selection to the set of selections as main.
1029
+ #
1030
+ # If the current selection is empty then select word around caret.
1031
+ # @return [void]
1032
+ def multiple_select_add_next; end
1033
+
1034
+ # Add each occurrence of the main selection in the target to the set of selections.
1035
+ #
1036
+ # If the current selection is empty then select word around caret.
1037
+ # @return [void]
1038
+ def multiple_select_add_each; end
1039
+
1040
+ # Show or hide the horizontal scroll bar.
1041
+ # @param visible [Boolean]
1042
+ # @return [void]
1043
+ def set_use_horizontal_scroll_bar(visible) end
1044
+ alias_method :use_horizontal_scroll_bar=, :set_use_horizontal_scroll_bar
1045
+
1046
+ # Is the horizontal scroll bar visible?
1047
+ # @return [Boolean]
1048
+ def get_use_horizontal_scroll_bar; end
1049
+ alias_method :use_horizontal_scroll_bar, :get_use_horizontal_scroll_bar
1050
+
1051
+ # Retrieve the display line at the top of the display.
1052
+ # @return [Integer]
1053
+ def get_first_visible_line; end
1054
+ alias_method :first_visible_line, :get_first_visible_line
1055
+
1056
+ # Scroll horizontally and vertically.
1057
+ # @param columns [Integer]
1058
+ # @param lines [Integer]
1059
+ # @return [void]
1060
+ def line_scroll(columns, lines) end
1061
+
1062
+ # Ensure the caret is visible.
1063
+ # @return [void]
1064
+ def ensure_caret_visible; end
1065
+
1066
+ # Scroll the argument positions and the range between them into view giving priority to the primary position then the secondary position.
1067
+ #
1068
+ # This may be used to make a search match visible.
1069
+ # @param secondary [Integer]
1070
+ # @param primary [Integer]
1071
+ # @return [void]
1072
+ def scroll_range(secondary, primary) end
1073
+
1074
+ # Sets the document width assumed for scrolling.
1075
+ # @param pixelWidth [Integer]
1076
+ # @return [void]
1077
+ def set_scroll_width(pixelWidth) end
1078
+ alias_method :scroll_width=, :set_scroll_width
1079
+
1080
+ # Retrieve the document width assumed for scrolling.
1081
+ # @return [Integer]
1082
+ def get_scroll_width; end
1083
+ alias_method :scroll_width, :get_scroll_width
1084
+
1085
+ # Sets whether the maximum width line displayed is used to set scroll width.
1086
+ # @param tracking [Boolean]
1087
+ # @return [void]
1088
+ def set_scroll_width_tracking(tracking) end
1089
+ alias_method :scroll_width_tracking=, :set_scroll_width_tracking
1090
+
1091
+ # Retrieve whether the scroll width tracks wide lines.
1092
+ # @return [Boolean]
1093
+ def get_scroll_width_tracking; end
1094
+ alias_method :scroll_width_tracking, :get_scroll_width_tracking
1095
+
1096
+ # Sets the scroll range so that maximum scroll position has the last line at the bottom of the view (default).
1097
+ #
1098
+ # Setting this to false allows scrolling one page below the last line.
1099
+ # @param endAtLastLine [Boolean]
1100
+ # @return [void]
1101
+ def set_end_at_last_line(endAtLastLine) end
1102
+ alias_method :end_at_last_line=, :set_end_at_last_line
1103
+
1104
+ # Retrieve whether the maximum scroll position has the last line at the bottom of the view.
1105
+ # @return [Boolean]
1106
+ def get_end_at_last_line; end
1107
+ alias_method :end_at_last_line, :get_end_at_last_line
1108
+
1109
+ # Show or hide the vertical scroll bar.
1110
+ # @param visible [Boolean]
1111
+ # @return [void]
1112
+ def set_use_vertical_scroll_bar(visible) end
1113
+ alias_method :use_vertical_scroll_bar=, :set_use_vertical_scroll_bar
1114
+
1115
+ # Is the vertical scroll bar visible?
1116
+ # @return [Boolean]
1117
+ def get_use_vertical_scroll_bar; end
1118
+ alias_method :use_vertical_scroll_bar, :get_use_vertical_scroll_bar
1119
+
1120
+ # Scroll so that a display line is at the top of the display.
1121
+ # @param displayLine [Integer]
1122
+ # @return [void]
1123
+ def set_first_visible_line(displayLine) end
1124
+ alias_method :first_visible_line=, :set_first_visible_line
1125
+
1126
+ # Set the way the display area is determined when a particular line is to be moved to by Find, FindNext, GotoLine, etc.
1127
+ #
1128
+ # The first argument should be a bit list containing one or more of the wxSTC_VISIBLE_* constants.
1129
+ # @param visiblePolicy [Integer]
1130
+ # @param visibleSlop [Integer]
1131
+ # @return [void]
1132
+ def set_visible_policy(visiblePolicy, visibleSlop) end
1133
+
1134
+ # Set the xOffset (ie, horizontal scroll position).
1135
+ # @param xOffset [Integer]
1136
+ # @return [void]
1137
+ def set_x_offset(xOffset) end
1138
+ alias_method :x_offset=, :set_x_offset
1139
+
1140
+ # Get the xOffset (ie, horizontal scroll position).
1141
+ # @return [Integer]
1142
+ def get_x_offset; end
1143
+ alias_method :x_offset, :get_x_offset
1144
+
1145
+ # Set the way the caret is kept visible when going sideways.
1146
+ #
1147
+ # The exclusion zone is given in pixels.
1148
+ # The first argument should be a bit list containing one or more of the wxSTC_CARET_* constants.
1149
+ # @param caretPolicy [Integer]
1150
+ # @param caretSlop [Integer]
1151
+ # @return [void]
1152
+ def set_x_caret_policy(caretPolicy, caretSlop) end
1153
+
1154
+ # Set the way the line the caret is on is kept visible.
1155
+ #
1156
+ # The exclusion zone is given in lines.
1157
+ # The first argument should be a bit list containing one or more of the wxSTC_CARET_* constants.
1158
+ # @param caretPolicy [Integer]
1159
+ # @param caretSlop [Integer]
1160
+ # @return [void]
1161
+ def set_y_caret_policy(caretPolicy, caretSlop) end
1162
+
1163
+ # Are white space characters currently visible?
1164
+ #
1165
+ # Returns one of {Wx::STC_WS_}* constants.
1166
+ # @return [Integer]
1167
+ def get_view_white_space; end
1168
+ alias_method :view_white_space, :get_view_white_space
1169
+
1170
+ # Make white space characters invisible, always visible or visible outside indentation.
1171
+ #
1172
+ # The input should be one of the wxSTC_WS_* constants.
1173
+ # @param viewWS [Integer]
1174
+ # @return [void]
1175
+ def set_view_white_space(viewWS) end
1176
+ alias_method :view_white_space=, :set_view_white_space
1177
+
1178
+ # Retrieve the current tab draw mode.
1179
+ #
1180
+ # Returns one of {Wx::STC_TD_}* constants.
1181
+ # @return [Integer]
1182
+ def get_tab_draw_mode; end
1183
+ alias_method :tab_draw_mode, :get_tab_draw_mode
1184
+
1185
+ # Set how tabs are drawn when visible.
1186
+ #
1187
+ # The input should be one of the wxSTC_TD_* constants.
1188
+ # @param tabDrawMode [Integer]
1189
+ # @return [void]
1190
+ def set_tab_draw_mode(tabDrawMode) end
1191
+ alias_method :tab_draw_mode=, :set_tab_draw_mode
1192
+
1193
+ # Set the foreground colour of all whitespace and whether to use this setting.
1194
+ # @param useSetting [Boolean]
1195
+ # @param fore [Wx::Colour,String,Symbol]
1196
+ # @return [void]
1197
+ def set_whitespace_foreground(useSetting, fore) end
1198
+
1199
+ # Set the background colour of all whitespace and whether to use this setting.
1200
+ # @param useSetting [Boolean]
1201
+ # @param back [Wx::Colour,String,Symbol]
1202
+ # @return [void]
1203
+ def set_whitespace_background(useSetting, back) end
1204
+
1205
+ # Set the size of the dots used to mark space characters.
1206
+ # @param size [Integer]
1207
+ # @return [void]
1208
+ def set_whitespace_size(size) end
1209
+ alias_method :whitespace_size=, :set_whitespace_size
1210
+
1211
+ # Get the size of the dots used to mark space characters.
1212
+ # @return [Integer]
1213
+ def get_whitespace_size; end
1214
+ alias_method :whitespace_size, :get_whitespace_size
1215
+
1216
+ # Set extra ascent for each line.
1217
+ # @param extraAscent [Integer]
1218
+ # @return [void]
1219
+ def set_extra_ascent(extraAscent) end
1220
+ alias_method :extra_ascent=, :set_extra_ascent
1221
+
1222
+ # Get extra ascent for each line.
1223
+ # @return [Integer]
1224
+ def get_extra_ascent; end
1225
+ alias_method :extra_ascent, :get_extra_ascent
1226
+
1227
+ # Set extra descent for each line.
1228
+ # @param extraDescent [Integer]
1229
+ # @return [void]
1230
+ def set_extra_descent(extraDescent) end
1231
+ alias_method :extra_descent=, :set_extra_descent
1232
+
1233
+ # Get extra descent for each line.
1234
+ # @return [Integer]
1235
+ def get_extra_descent; end
1236
+ alias_method :extra_descent, :get_extra_descent
1237
+
1238
+ # Sets the cursor to one of the {Wx::STC_CURSOR}* values.
1239
+ # @param cursorType [Integer]
1240
+ # @return [void]
1241
+ def set_stc_cursor(cursorType) end
1242
+ alias_method :stc_cursor=, :set_stc_cursor
1243
+
1244
+ # Get cursor type.
1245
+ #
1246
+ # The return value will be one of the wxSTC_CURSOR* constants.
1247
+ # @return [Integer]
1248
+ def get_stc_cursor; end
1249
+ alias_method :stc_cursor, :get_stc_cursor
1250
+
1251
+ # Set whether the mouse is captured when its button is pressed.
1252
+ # @param captures [Boolean]
1253
+ # @return [void]
1254
+ def set_mouse_down_captures(captures) end
1255
+ alias_method :mouse_down_captures=, :set_mouse_down_captures
1256
+
1257
+ # Get whether mouse gets captured.
1258
+ # @return [Boolean]
1259
+ def get_mouse_down_captures; end
1260
+ alias_method :mouse_down_captures, :get_mouse_down_captures
1261
+
1262
+ # Set whether the mouse wheel can be active outside the window.
1263
+ # @param captures [Boolean]
1264
+ # @return [void]
1265
+ def set_mouse_wheel_captures(captures) end
1266
+ alias_method :mouse_wheel_captures=, :set_mouse_wheel_captures
1267
+
1268
+ # Get whether mouse wheel can be active outside the window.
1269
+ # @return [Boolean]
1270
+ def get_mouse_wheel_captures; end
1271
+ alias_method :mouse_wheel_captures, :get_mouse_wheel_captures
1272
+
1273
+ # Convert all line endings in the document to one mode.
1274
+ # @param eolMode [Integer]
1275
+ # @return [void]
1276
+ def convert_eo_ls(eolMode) end
1277
+
1278
+ # Retrieve the current end of line mode - one of {Wx::STC::STC_EOL_CRLF}, {Wx::STC::STC_EOL_CR}, or {Wx::STC::STC_EOL_LF}.
1279
+ # @return [Integer]
1280
+ def get_eol_mode; end
1281
+ alias_method :eol_mode, :get_eol_mode
1282
+
1283
+ # Set the current end of line mode.
1284
+ #
1285
+ # The input should be one of the wxSTC_EOL_* constants.
1286
+ # @param eolMode [Integer]
1287
+ # @return [void]
1288
+ def set_eol_mode(eolMode) end
1289
+ alias_method :eol_mode=, :set_eol_mode
1290
+
1291
+ # Are the end of line characters visible?
1292
+ # @return [Boolean]
1293
+ def get_view_eol; end
1294
+ alias_method :view_eol, :get_view_eol
1295
+
1296
+ # Make the end of line characters visible or invisible.
1297
+ # @param visible [Boolean]
1298
+ # @return [void]
1299
+ def set_view_eol(visible) end
1300
+ alias_method :view_eol=, :set_view_eol
1301
+
1302
+ # Set the line end types that the application wants to use.
1303
+ #
1304
+ # May not be used if incompatible with lexer or encoding.
1305
+ # The input should be one of the wxSTC_LINE_END_TYPE_* constants.
1306
+ # @param lineEndBitSet [Integer]
1307
+ # @return [void]
1308
+ def set_line_end_types_allowed(lineEndBitSet) end
1309
+ alias_method :line_end_types_allowed=, :set_line_end_types_allowed
1310
+
1311
+ # Get the line end types currently allowed.
1312
+ #
1313
+ # The return value will be one of the wxSTC_LINE_END_TYPE_* constants.
1314
+ # @return [Integer]
1315
+ def get_line_end_types_allowed; end
1316
+ alias_method :line_end_types_allowed, :get_line_end_types_allowed
1317
+
1318
+ # Get the line end types currently recognised.
1319
+ #
1320
+ # May be a subset of the allowed types due to lexer limitation.
1321
+ # The return value will be one of the wxSTC_LINE_END_TYPE_* constants.
1322
+ # @return [Integer]
1323
+ def get_line_end_types_active; end
1324
+ alias_method :line_end_types_active, :get_line_end_types_active
1325
+
1326
+ # Bit set of LineEndType enumertion for which line ends beyond the standard LF, CR, and CRLF are supported by the lexer.
1327
+ #
1328
+ # The return value will be a bit list containing one or more of the wxSTC_LINE_END_TYPE_* constants.
1329
+ # @return [Integer]
1330
+ def get_line_end_types_supported; end
1331
+ alias_method :line_end_types_supported, :get_line_end_types_supported
1332
+
1333
+ # Set the set of characters making up words for when moving or selecting by word.
1334
+ #
1335
+ # First sets defaults like SetCharsDefault.
1336
+ # @param characters [String]
1337
+ # @return [void]
1338
+ def set_word_chars(characters) end
1339
+ alias_method :word_chars=, :set_word_chars
1340
+
1341
+ # Get the set of characters making up words for when moving or selecting by word.
1342
+ # @return [String]
1343
+ def get_word_chars; end
1344
+ alias_method :word_chars, :get_word_chars
1345
+
1346
+ # Get position of start of word.
1347
+ # @param pos [Integer]
1348
+ # @param onlyWordCharacters [Boolean]
1349
+ # @return [Integer]
1350
+ def word_start_position(pos, onlyWordCharacters) end
1351
+
1352
+ # Get position of end of word.
1353
+ # @param pos [Integer]
1354
+ # @param onlyWordCharacters [Boolean]
1355
+ # @return [Integer]
1356
+ def word_end_position(pos, onlyWordCharacters) end
1357
+
1358
+ # Is the range start..end considered a word?
1359
+ # @param start [Integer]
1360
+ # @param end_ [Integer]
1361
+ # @return [Boolean]
1362
+ def is_range_word(start, end_) end
1363
+ alias_method :range_word?, :is_range_word
1364
+
1365
+ # Set the set of characters making up whitespace for when moving or selecting by word.
1366
+ #
1367
+ # Should be called after SetWordChars.
1368
+ # @param characters [String]
1369
+ # @return [void]
1370
+ def set_whitespace_chars(characters) end
1371
+ alias_method :whitespace_chars=, :set_whitespace_chars
1372
+
1373
+ # Get the set of characters making up whitespace for when moving or selecting by word.
1374
+ # @return [String]
1375
+ def get_whitespace_chars; end
1376
+ alias_method :whitespace_chars, :get_whitespace_chars
1377
+
1378
+ # Set the set of characters making up punctuation characters Should be called after SetWordChars.
1379
+ # @param characters [String]
1380
+ # @return [void]
1381
+ def set_punctuation_chars(characters) end
1382
+ alias_method :punctuation_chars=, :set_punctuation_chars
1383
+
1384
+ # Get the set of characters making up punctuation characters.
1385
+ # @return [String]
1386
+ def get_punctuation_chars; end
1387
+ alias_method :punctuation_chars, :get_punctuation_chars
1388
+
1389
+ # Reset the set of characters for whitespace and word characters to the defaults.
1390
+ # @return [void]
1391
+ def set_chars_default; end
1392
+
1393
+ # Retrieve the position of the last correctly styled character.
1394
+ # @return [Integer]
1395
+ def get_end_styled; end
1396
+ alias_method :end_styled, :get_end_styled
1397
+
1398
+ # Set the current styling position to start.
1399
+ # @param start [Integer]
1400
+ # @return [void]
1401
+ def start_styling(start) end
1402
+
1403
+ # Change style from current styling position for length characters to a style and move the current styling position to after this newly styled segment.
1404
+ # @param length [Integer]
1405
+ # @param style [Integer]
1406
+ # @return [void]
1407
+ def set_styling(length, style) end
1408
+
1409
+ # Used to hold extra styling information for each line.
1410
+ # @param line [Integer]
1411
+ # @param state [Integer]
1412
+ # @return [void]
1413
+ def set_line_state(line, state) end
1414
+
1415
+ # Retrieve the extra styling information for a line.
1416
+ # @param line [Integer]
1417
+ # @return [Integer]
1418
+ def get_line_state(line) end
1419
+ alias_method :line_state, :get_line_state
1420
+
1421
+ # Retrieve the last line number that has line state.
1422
+ # @return [Integer]
1423
+ def get_max_line_state; end
1424
+ alias_method :max_line_state, :get_max_line_state
1425
+
1426
+ # Sets limits to idle styling.
1427
+ #
1428
+ # The input should be one of the wxSTC_IDLESTYLING_* constants.
1429
+ # @param idleStyling [Integer]
1430
+ # @return [void]
1431
+ def set_idle_styling(idleStyling) end
1432
+ alias_method :idle_styling=, :set_idle_styling
1433
+
1434
+ # Retrieve the limits to idle styling.
1435
+ #
1436
+ # The return value will be one of the wxSTC_IDLESTYLING_* constants.
1437
+ # @return [Integer]
1438
+ def get_idle_styling; end
1439
+ alias_method :idle_styling, :get_idle_styling
1440
+
1441
+ # Clear all the styles and make equivalent to the global default style.
1442
+ # @return [void]
1443
+ def style_clear_all; end
1444
+
1445
+ # Set the foreground colour of a style.
1446
+ # @param style [Integer]
1447
+ # @param fore [Wx::Colour,String,Symbol]
1448
+ # @return [void]
1449
+ def style_set_foreground(style, fore) end
1450
+
1451
+ # Set the background colour of a style.
1452
+ # @param style [Integer]
1453
+ # @param back [Wx::Colour,String,Symbol]
1454
+ # @return [void]
1455
+ def style_set_background(style, back) end
1456
+
1457
+ # Set a style to be bold or not.
1458
+ # @param style [Integer]
1459
+ # @param bold [Boolean]
1460
+ # @return [void]
1461
+ def style_set_bold(style, bold) end
1462
+
1463
+ # Set a style to be italic or not.
1464
+ # @param style [Integer]
1465
+ # @param italic [Boolean]
1466
+ # @return [void]
1467
+ def style_set_italic(style, italic) end
1468
+
1469
+ # Set the size of characters of a style.
1470
+ # @param style [Integer]
1471
+ # @param sizePoints [Integer]
1472
+ # @return [void]
1473
+ def style_set_size(style, sizePoints) end
1474
+
1475
+ # Set the font of a style.
1476
+ # @param style [Integer]
1477
+ # @param fontName [String]
1478
+ # @return [void]
1479
+ def style_set_face_name(style, fontName) end
1480
+
1481
+ # Set a style to have its end of line filled or not.
1482
+ # @param style [Integer]
1483
+ # @param eolFilled [Boolean]
1484
+ # @return [void]
1485
+ def style_set_eol_filled(style, eolFilled) end
1486
+
1487
+ # Reset the default style to its state at startup.
1488
+ # @return [void]
1489
+ def style_reset_default; end
1490
+
1491
+ # Set a style to be underlined or not.
1492
+ # @param style [Integer]
1493
+ # @param underline [Boolean]
1494
+ # @return [void]
1495
+ def style_set_underline(style, underline) end
1496
+
1497
+ # Get the foreground colour of a style.
1498
+ # @param style [Integer]
1499
+ # @return [Wx::Colour]
1500
+ def style_get_foreground(style) end
1501
+
1502
+ # Get the background colour of a style.
1503
+ # @param style [Integer]
1504
+ # @return [Wx::Colour]
1505
+ def style_get_background(style) end
1506
+
1507
+ # Get is a style bold or not.
1508
+ # @param style [Integer]
1509
+ # @return [Boolean]
1510
+ def style_get_bold(style) end
1511
+
1512
+ # Get is a style italic or not.
1513
+ # @param style [Integer]
1514
+ # @return [Boolean]
1515
+ def style_get_italic(style) end
1516
+
1517
+ # Get the size of characters of a style.
1518
+ # @param style [Integer]
1519
+ # @return [Integer]
1520
+ def style_get_size(style) end
1521
+
1522
+ # Get the font facename of a style.
1523
+ # @param style [Integer]
1524
+ # @return [String]
1525
+ def style_get_face_name(style) end
1526
+
1527
+ # Get is a style to have its end of line filled or not.
1528
+ # @param style [Integer]
1529
+ # @return [Boolean]
1530
+ def style_get_eol_filled(style) end
1531
+
1532
+ # Get is a style underlined or not.
1533
+ # @param style [Integer]
1534
+ # @return [Boolean]
1535
+ def style_get_underline(style) end
1536
+
1537
+ # Get is a style mixed case, or to force upper or lower case.
1538
+ #
1539
+ # The return value will be one of the wxSTC_CASE_* constants.
1540
+ # @param style [Integer]
1541
+ # @return [Integer]
1542
+ def style_get_case(style) end
1543
+
1544
+ # Get the character get of the font in a style.
1545
+ # @param style [Integer]
1546
+ # @return [Integer]
1547
+ def style_get_character_set(style) end
1548
+
1549
+ # Get is a style visible or not.
1550
+ # @param style [Integer]
1551
+ # @return [Boolean]
1552
+ def style_get_visible(style) end
1553
+
1554
+ # Get is a style changeable or not (read only).
1555
+ #
1556
+ # Experimental feature, currently buggy.
1557
+ # @param style [Integer]
1558
+ # @return [Boolean]
1559
+ def style_get_changeable(style) end
1560
+
1561
+ # Get is a style a hotspot or not.
1562
+ # @param style [Integer]
1563
+ # @return [Boolean]
1564
+ def style_get_hot_spot(style) end
1565
+
1566
+ # Set a style to be mixed case, or to force upper or lower case.
1567
+ #
1568
+ # The second argument should be one of the wxSTC_CASE_* constants.
1569
+ # @param style [Integer]
1570
+ # @param caseVisible [Integer]
1571
+ # @return [void]
1572
+ def style_set_case(style, caseVisible) end
1573
+
1574
+ # Set the size of characters of a style.
1575
+ #
1576
+ # Size is in points multiplied by 100.
1577
+ # @param style [Integer]
1578
+ # @param sizeHundredthPoints [Integer]
1579
+ # @return [void]
1580
+ def style_set_size_fractional(style, sizeHundredthPoints) end
1581
+
1582
+ # Get the size of characters of a style in points multiplied by 100.
1583
+ # @param style [Integer]
1584
+ # @return [Integer]
1585
+ def style_get_size_fractional(style) end
1586
+
1587
+ # Set the weight of characters of a style.
1588
+ #
1589
+ # The second argument can be an integer or one of the wxSTC_WEIGHT_* constants.
1590
+ # @param style [Integer]
1591
+ # @param weight [Integer]
1592
+ # @return [void]
1593
+ def style_set_weight(style, weight) end
1594
+
1595
+ # Get the weight of characters of a style.
1596
+ #
1597
+ # The return value will be an integer that is possibly one of the wxSTC_WEIGHT_* constants.
1598
+ # @param style [Integer]
1599
+ # @return [Integer]
1600
+ def style_get_weight(style) end
1601
+
1602
+ # Set the character set of the font in a style.
1603
+ #
1604
+ # Converts the Scintilla character set values to a {Wx::FontEncoding}.
1605
+ # @param style [Integer]
1606
+ # @param characterSet [Integer]
1607
+ # @return [void]
1608
+ def style_set_character_set(style, characterSet) end
1609
+
1610
+ # Set a style to be a hotspot or not.
1611
+ # @param style [Integer]
1612
+ # @param hotspot [Boolean]
1613
+ # @return [void]
1614
+ def style_set_hot_spot(style, hotspot) end
1615
+
1616
+ # Set a style to be visible or not.
1617
+ # @param style [Integer]
1618
+ # @param visible [Boolean]
1619
+ # @return [void]
1620
+ def style_set_visible(style, visible) end
1621
+
1622
+ # Set a style to be changeable or not (read only).
1623
+ #
1624
+ # Experimental feature, currently buggy.
1625
+ # @param style [Integer]
1626
+ # @param changeable [Boolean]
1627
+ # @return [void]
1628
+ def style_set_changeable(style, changeable) end
1629
+
1630
+ # Set the foreground colour of the main and additional selections and whether to use this setting.
1631
+ # @param useSetting [Boolean]
1632
+ # @param fore [Wx::Colour,String,Symbol]
1633
+ # @return [void]
1634
+ def set_sel_foreground(useSetting, fore) end
1635
+
1636
+ # Set the background colour of the main and additional selections and whether to use this setting.
1637
+ # @param useSetting [Boolean]
1638
+ # @param back [Wx::Colour,String,Symbol]
1639
+ # @return [void]
1640
+ def set_sel_background(useSetting, back) end
1641
+
1642
+ # Get the alpha of the selection.
1643
+ # @return [Integer]
1644
+ def get_sel_alpha; end
1645
+ alias_method :sel_alpha, :get_sel_alpha
1646
+
1647
+ # Set the alpha of the selection.
1648
+ # @param alpha [Integer]
1649
+ # @return [void]
1650
+ def set_sel_alpha(alpha) end
1651
+ alias_method :sel_alpha=, :set_sel_alpha
1652
+
1653
+ # Is the selection end of line filled?
1654
+ # @return [Boolean]
1655
+ def get_sel_eol_filled; end
1656
+ alias_method :sel_eol_filled, :get_sel_eol_filled
1657
+
1658
+ # Set the selection to have its end of line filled or not.
1659
+ # @param filled [Boolean]
1660
+ # @return [void]
1661
+ def set_sel_eol_filled(filled) end
1662
+ alias_method :sel_eol_filled=, :set_sel_eol_filled
1663
+
1664
+ # Set the foreground colour of the caret.
1665
+ # @param fore [Wx::Colour,String,Symbol]
1666
+ # @return [void]
1667
+ def set_caret_foreground(fore) end
1668
+ alias_method :caret_foreground=, :set_caret_foreground
1669
+
1670
+ # Get the time in milliseconds that the caret is on and off.
1671
+ # @return [Integer]
1672
+ def get_caret_period; end
1673
+ alias_method :caret_period, :get_caret_period
1674
+
1675
+ # Get the time in milliseconds that the caret is on and off.
1676
+ #
1677
+ # 0 = steady on.
1678
+ # @param periodMilliseconds [Integer]
1679
+ # @return [void]
1680
+ def set_caret_period(periodMilliseconds) end
1681
+ alias_method :caret_period=, :set_caret_period
1682
+
1683
+ # Is the background of the line containing the caret in a different colour?
1684
+ # @return [Boolean]
1685
+ def get_caret_line_visible; end
1686
+ alias_method :caret_line_visible, :get_caret_line_visible
1687
+
1688
+ # Display the background of the line containing the caret in a different colour.
1689
+ # @param show [Boolean]
1690
+ # @return [void]
1691
+ def set_caret_line_visible(show) end
1692
+ alias_method :caret_line_visible=, :set_caret_line_visible
1693
+
1694
+ # Get the colour of the background of the line containing the caret.
1695
+ # @return [Wx::Colour]
1696
+ def get_caret_line_background; end
1697
+ alias_method :caret_line_background, :get_caret_line_background
1698
+
1699
+ # Set the colour of the background of the line containing the caret.
1700
+ # @param back [Wx::Colour,String,Symbol]
1701
+ # @return [void]
1702
+ def set_caret_line_background(back) end
1703
+ alias_method :caret_line_background=, :set_caret_line_background
1704
+
1705
+ # Get the foreground colour of the caret.
1706
+ # @return [Wx::Colour]
1707
+ def get_caret_foreground; end
1708
+ alias_method :caret_foreground, :get_caret_foreground
1709
+
1710
+ # Set the width of the insert mode caret.
1711
+ # @param pixelWidth [Integer]
1712
+ # @return [void]
1713
+ def set_caret_width(pixelWidth) end
1714
+ alias_method :caret_width=, :set_caret_width
1715
+
1716
+ # Returns the width of the insert mode caret.
1717
+ # @return [Integer]
1718
+ def get_caret_width; end
1719
+ alias_method :caret_width, :get_caret_width
1720
+
1721
+ # Set a fore colour for active hotspots.
1722
+ # @param useSetting [Boolean]
1723
+ # @param fore [Wx::Colour,String,Symbol]
1724
+ # @return [void]
1725
+ def set_hotspot_active_foreground(useSetting, fore) end
1726
+
1727
+ # Get the fore colour for active hotspots.
1728
+ # @return [Wx::Colour]
1729
+ def get_hotspot_active_foreground; end
1730
+ alias_method :hotspot_active_foreground, :get_hotspot_active_foreground
1731
+
1732
+ # Set a back colour for active hotspots.
1733
+ # @param useSetting [Boolean]
1734
+ # @param back [Wx::Colour,String,Symbol]
1735
+ # @return [void]
1736
+ def set_hotspot_active_background(useSetting, back) end
1737
+
1738
+ # Get the back colour for active hotspots.
1739
+ # @return [Wx::Colour]
1740
+ def get_hotspot_active_background; end
1741
+ alias_method :hotspot_active_background, :get_hotspot_active_background
1742
+
1743
+ # Enable / Disable underlining active hotspots.
1744
+ # @param underline [Boolean]
1745
+ # @return [void]
1746
+ def set_hotspot_active_underline(underline) end
1747
+ alias_method :hotspot_active_underline=, :set_hotspot_active_underline
1748
+
1749
+ # Get whether underlining for active hotspots.
1750
+ # @return [Boolean]
1751
+ def get_hotspot_active_underline; end
1752
+ alias_method :hotspot_active_underline, :get_hotspot_active_underline
1753
+
1754
+ # Limit hotspots to single line so hotspots on two lines don't merge.
1755
+ # @param singleLine [Boolean]
1756
+ # @return [void]
1757
+ def set_hotspot_single_line(singleLine) end
1758
+ alias_method :hotspot_single_line=, :set_hotspot_single_line
1759
+
1760
+ # Get the HotspotSingleLine property.
1761
+ # @return [Boolean]
1762
+ def get_hotspot_single_line; end
1763
+ alias_method :hotspot_single_line, :get_hotspot_single_line
1764
+
1765
+ # Can the caret preferred x position only be changed by explicit movement commands?
1766
+ #
1767
+ # The return value will be one of the wxSTC_CARETSTICKY_* constants.
1768
+ # @return [Integer]
1769
+ def get_caret_sticky; end
1770
+ alias_method :caret_sticky, :get_caret_sticky
1771
+
1772
+ # Stop the caret preferred x position changing when the user types.
1773
+ #
1774
+ # The input should be one of the wxSTC_CARETSTICKY_* constants.
1775
+ # @param useCaretStickyBehaviour [Integer]
1776
+ # @return [void]
1777
+ def set_caret_sticky(useCaretStickyBehaviour) end
1778
+ alias_method :caret_sticky=, :set_caret_sticky
1779
+
1780
+ # Switch between sticky and non-sticky: meant to be bound to a key.
1781
+ # @return [void]
1782
+ def toggle_caret_sticky; end
1783
+
1784
+ # Set background alpha of the caret line.
1785
+ # @param alpha [Integer]
1786
+ # @return [void]
1787
+ def set_caret_line_back_alpha(alpha) end
1788
+ alias_method :caret_line_back_alpha=, :set_caret_line_back_alpha
1789
+
1790
+ # Get the background alpha of the caret line.
1791
+ # @return [Integer]
1792
+ def get_caret_line_back_alpha; end
1793
+ alias_method :caret_line_back_alpha, :get_caret_line_back_alpha
1794
+
1795
+ # Set the style of the caret to be drawn.
1796
+ #
1797
+ # The input should be one of the wxSTC_CARETSTYLE_* constants.
1798
+ # @param caretStyle [Integer]
1799
+ # @return [void]
1800
+ def set_caret_style(caretStyle) end
1801
+ alias_method :caret_style=, :set_caret_style
1802
+
1803
+ # Returns the current style of the caret.
1804
+ #
1805
+ # The return value will be one of the wxSTC_CARETSTYLE_* constants.
1806
+ # @return [Integer]
1807
+ def get_caret_style; end
1808
+ alias_method :caret_style, :get_caret_style
1809
+
1810
+ # Is the caret line always visible?
1811
+ # @return [Boolean]
1812
+ def get_caret_line_visible_always; end
1813
+ alias_method :caret_line_visible_always, :get_caret_line_visible_always
1814
+
1815
+ # Sets the caret line to always visible.
1816
+ # @param alwaysVisible [Boolean]
1817
+ # @return [void]
1818
+ def set_caret_line_visible_always(alwaysVisible) end
1819
+ alias_method :caret_line_visible_always=, :set_caret_line_visible_always
1820
+
1821
+ # Change the way control characters are displayed: If symbol is < 32, keep the drawn way, else, use the given character.
1822
+ # @param symbol [Integer]
1823
+ # @return [void]
1824
+ def set_control_char_symbol(symbol) end
1825
+ alias_method :control_char_symbol=, :set_control_char_symbol
1826
+
1827
+ # Get the way control characters are displayed.
1828
+ # @return [Integer]
1829
+ def get_control_char_symbol; end
1830
+ alias_method :control_char_symbol, :get_control_char_symbol
1831
+
1832
+ # Set the way a character is drawn.
1833
+ # @param encodedCharacter [String]
1834
+ # @param representation [String]
1835
+ # @return [void]
1836
+ def set_representation(encodedCharacter, representation) end
1837
+
1838
+ # Set the way a character is drawn.
1839
+ # @param encodedCharacter [String]
1840
+ # @return [String]
1841
+ def get_representation(encodedCharacter) end
1842
+ alias_method :representation, :get_representation
1843
+
1844
+ # Remove a character representation.
1845
+ # @param encodedCharacter [String]
1846
+ # @return [void]
1847
+ def clear_representation(encodedCharacter) end
1848
+
1849
+ # Set a margin to be either numeric or symbolic.
1850
+ #
1851
+ # The second argument should be one of the wxSTC_MARGIN_* constants.
1852
+ # @param margin [Integer]
1853
+ # @param marginType [Integer]
1854
+ # @return [void]
1855
+ def set_margin_type(margin, marginType) end
1856
+
1857
+ # Retrieve the type of a margin.
1858
+ #
1859
+ # The return value will be one of the wxSTC_MARGIN_* constants.
1860
+ # @param margin [Integer]
1861
+ # @return [Integer]
1862
+ def get_margin_type(margin) end
1863
+ alias_method :margin_type, :get_margin_type
1864
+
1865
+ # Set the width of a margin to a width expressed in pixels.
1866
+ # @param margin [Integer]
1867
+ # @param pixelWidth [Integer]
1868
+ # @return [void]
1869
+ def set_margin_width(margin, pixelWidth) end
1870
+
1871
+ # Retrieve the width of a margin in pixels.
1872
+ # @param margin [Integer]
1873
+ # @return [Integer]
1874
+ def get_margin_width(margin) end
1875
+ alias_method :margin_width, :get_margin_width
1876
+
1877
+ # Set a mask that determines which markers are displayed in a margin.
1878
+ # @param margin [Integer]
1879
+ # @param mask [Integer]
1880
+ # @return [void]
1881
+ def set_margin_mask(margin, mask) end
1882
+
1883
+ # Retrieve the marker mask of a margin.
1884
+ # @param margin [Integer]
1885
+ # @return [Integer]
1886
+ def get_margin_mask(margin) end
1887
+ alias_method :margin_mask, :get_margin_mask
1888
+
1889
+ # Make a margin sensitive or insensitive to mouse clicks.
1890
+ # @param margin [Integer]
1891
+ # @param sensitive [Boolean]
1892
+ # @return [void]
1893
+ def set_margin_sensitive(margin, sensitive) end
1894
+
1895
+ # Retrieve the mouse click sensitivity of a margin.
1896
+ # @param margin [Integer]
1897
+ # @return [Boolean]
1898
+ def get_margin_sensitive(margin) end
1899
+ alias_method :margin_sensitive, :get_margin_sensitive
1900
+
1901
+ # Set the cursor shown when the mouse is inside a margin.
1902
+ #
1903
+ # The second argument should be one of the wxSTC_CURSOR* constants.
1904
+ # @param margin [Integer]
1905
+ # @param cursor [Integer]
1906
+ # @return [void]
1907
+ def set_margin_cursor(margin, cursor) end
1908
+
1909
+ # Retrieve the cursor shown in a margin.
1910
+ #
1911
+ # The return value will be one of the wxSTC_CURSOR* constants.
1912
+ # @param margin [Integer]
1913
+ # @return [Integer]
1914
+ def get_margin_cursor(margin) end
1915
+ alias_method :margin_cursor, :get_margin_cursor
1916
+
1917
+ # Set the background colour of a margin.
1918
+ #
1919
+ # Only visible for {Wx::STC::STC_MARGIN_COLOUR}.
1920
+ # @param margin [Integer]
1921
+ # @param back [Wx::Colour,String,Symbol]
1922
+ # @return [void]
1923
+ def set_margin_background(margin, back) end
1924
+
1925
+ # Retrieve the background colour of a margin.
1926
+ # @param margin [Integer]
1927
+ # @return [Wx::Colour]
1928
+ def get_margin_background(margin) end
1929
+ alias_method :margin_background, :get_margin_background
1930
+
1931
+ # Allocate a non-standard number of margins.
1932
+ # @param margins [Integer]
1933
+ # @return [void]
1934
+ def set_margin_count(margins) end
1935
+ alias_method :margin_count=, :set_margin_count
1936
+
1937
+ # How many margins are there?
1938
+ # @return [Integer]
1939
+ def get_margin_count; end
1940
+ alias_method :margin_count, :get_margin_count
1941
+
1942
+ # Sets the size in pixels of the left margin.
1943
+ # @param pixelWidth [Integer]
1944
+ # @return [void]
1945
+ def set_margin_left(pixelWidth) end
1946
+ alias_method :margin_left=, :set_margin_left
1947
+
1948
+ # Returns the size in pixels of the left margin.
1949
+ # @return [Integer]
1950
+ def get_margin_left; end
1951
+ alias_method :margin_left, :get_margin_left
1952
+
1953
+ # Sets the size in pixels of the right margin.
1954
+ # @param pixelWidth [Integer]
1955
+ # @return [void]
1956
+ def set_margin_right(pixelWidth) end
1957
+ alias_method :margin_right=, :set_margin_right
1958
+
1959
+ # Returns the size in pixels of the right margin.
1960
+ # @return [Integer]
1961
+ def get_margin_right; end
1962
+ alias_method :margin_right, :get_margin_right
1963
+
1964
+ # Set one of the colours used as a chequerboard pattern in the fold margin.
1965
+ # @param useSetting [Boolean]
1966
+ # @param back [Wx::Colour,String,Symbol]
1967
+ # @return [void]
1968
+ def set_fold_margin_colour(useSetting, back) end
1969
+
1970
+ # Set the other colour used as a chequerboard pattern in the fold margin.
1971
+ # @param useSetting [Boolean]
1972
+ # @param fore [Wx::Colour,String,Symbol]
1973
+ # @return [void]
1974
+ def set_fold_margin_hi_colour(useSetting, fore) end
1975
+
1976
+ # Set the text in the text margin for a line.
1977
+ # @param line [Integer]
1978
+ # @param text [String]
1979
+ # @return [void]
1980
+ def margin_set_text(line, text) end
1981
+
1982
+ # Get the text in the text margin for a line.
1983
+ # @param line [Integer]
1984
+ # @return [String]
1985
+ def margin_get_text(line) end
1986
+
1987
+ # Set the style number for the text margin for a line.
1988
+ # @param line [Integer]
1989
+ # @param style [Integer]
1990
+ # @return [void]
1991
+ def margin_set_style(line, style) end
1992
+
1993
+ # Get the style number for the text margin for a line.
1994
+ # @param line [Integer]
1995
+ # @return [Integer]
1996
+ def margin_get_style(line) end
1997
+
1998
+ # Set the style in the text margin for a line.
1999
+ # @param line [Integer]
2000
+ # @param styles [String]
2001
+ # @return [void]
2002
+ def margin_set_styles(line, styles) end
2003
+
2004
+ # Get the styles in the text margin for a line.
2005
+ # @param line [Integer]
2006
+ # @return [String]
2007
+ def margin_get_styles(line) end
2008
+
2009
+ # Clear the margin text on all lines.
2010
+ # @return [void]
2011
+ def margin_text_clear_all; end
2012
+
2013
+ # Get the start of the range of style numbers used for margin text.
2014
+ # @param style [Integer]
2015
+ # @return [void]
2016
+ def margin_set_style_offset(style) end
2017
+
2018
+ # Get the start of the range of style numbers used for margin text.
2019
+ # @return [Integer]
2020
+ def margin_get_style_offset; end
2021
+
2022
+ # Set the margin options.
2023
+ #
2024
+ # The input should be one of the wxSTC_MARGINOPTION_* constants.
2025
+ # @param marginOptions [Integer]
2026
+ # @return [void]
2027
+ def set_margin_options(marginOptions) end
2028
+ alias_method :margin_options=, :set_margin_options
2029
+
2030
+ # Get the margin options.
2031
+ #
2032
+ # The return value will be one of the wxSTC_MARGINOPTION_* constants.
2033
+ # @return [Integer]
2034
+ def get_margin_options; end
2035
+ alias_method :margin_options, :get_margin_options
2036
+
2037
+ # Set the annotation text for a line.
2038
+ # @param line [Integer]
2039
+ # @param text [String]
2040
+ # @return [void]
2041
+ def annotation_set_text(line, text) end
2042
+
2043
+ # Get the annotation text for a line.
2044
+ # @param line [Integer]
2045
+ # @return [String]
2046
+ def annotation_get_text(line) end
2047
+
2048
+ # Set the style number for the annotations for a line.
2049
+ # @param line [Integer]
2050
+ # @param style [Integer]
2051
+ # @return [void]
2052
+ def annotation_set_style(line, style) end
2053
+
2054
+ # Get the style number for the annotations for a line.
2055
+ # @param line [Integer]
2056
+ # @return [Integer]
2057
+ def annotation_get_style(line) end
2058
+
2059
+ # Set the annotation styles for a line.
2060
+ # @param line [Integer]
2061
+ # @param styles [String]
2062
+ # @return [void]
2063
+ def annotation_set_styles(line, styles) end
2064
+
2065
+ # Get the annotation styles for a line.
2066
+ # @param line [Integer]
2067
+ # @return [String]
2068
+ def annotation_get_styles(line) end
2069
+
2070
+ # Get the number of annotation lines for a line.
2071
+ # @param line [Integer]
2072
+ # @return [Integer]
2073
+ def annotation_get_lines(line) end
2074
+
2075
+ # Clear the annotations from all lines.
2076
+ # @return [void]
2077
+ def annotation_clear_all; end
2078
+
2079
+ # Set the visibility for the annotations for a view.
2080
+ #
2081
+ # The input should be one of the wxSTC_ANNOTATION_* constants.
2082
+ # @param visible [Integer]
2083
+ # @return [void]
2084
+ def annotation_set_visible(visible) end
2085
+
2086
+ # Get the visibility for the annotations for a view.
2087
+ #
2088
+ # The return value will be one of the wxSTC_ANNOTATION_* constants.
2089
+ # @return [Integer]
2090
+ def annotation_get_visible; end
2091
+
2092
+ # Get the start of the range of style numbers used for annotations.
2093
+ # @param style [Integer]
2094
+ # @return [void]
2095
+ def annotation_set_style_offset(style) end
2096
+
2097
+ # Get the start of the range of style numbers used for annotations.
2098
+ # @return [Integer]
2099
+ def annotation_get_style_offset; end
2100
+
2101
+ # Retrieve marker handles of a line.
2102
+ # @param line [Integer]
2103
+ # @param which [Integer]
2104
+ # @return [Integer]
2105
+ def marker_handle_from_line(line, which) end
2106
+
2107
+ # Retrieve marker number of a marker handle.
2108
+ # @param line [Integer]
2109
+ # @param which [Integer]
2110
+ # @return [Integer]
2111
+ def marker_number_from_line(line, which) end
2112
+
2113
+ # Is drawing done first into a buffer or direct to the screen?
2114
+ # @return [Boolean]
2115
+ def get_buffered_draw; end
2116
+ alias_method :buffered_draw, :get_buffered_draw
2117
+
2118
+ # If drawing is buffered then each line of text is drawn into a bitmap buffer before drawing it to the screen to avoid flicker.
2119
+ # @param buffered [Boolean]
2120
+ # @return [void]
2121
+ def set_buffered_draw(buffered) end
2122
+ alias_method :buffered_draw=, :set_buffered_draw
2123
+
2124
+ # Set the minimum visual width of a tab.
2125
+ # @param pixels [Integer]
2126
+ # @return [void]
2127
+ def set_tab_minimum_width(pixels) end
2128
+ alias_method :tab_minimum_width=, :set_tab_minimum_width
2129
+
2130
+ # Get the minimum visual width of a tab.
2131
+ # @return [Integer]
2132
+ def get_tab_minimum_width; end
2133
+ alias_method :tab_minimum_width, :get_tab_minimum_width
2134
+
2135
+ # Set the code page used to interpret the bytes of the document as characters.
2136
+ # @param codePage [Integer]
2137
+ # @return [void]
2138
+ def set_code_page(codePage) end
2139
+ alias_method :code_page=, :set_code_page
2140
+
2141
+ # Is the IME displayed in a window or inline?
2142
+ #
2143
+ # The return value will be one of the wxSTC_IME_* constants.
2144
+ # @return [Integer]
2145
+ def get_ime_interaction; end
2146
+ alias_method :ime_interaction, :get_ime_interaction
2147
+
2148
+ # Choose to display the IME in a window or inline.
2149
+ #
2150
+ # The input should be one of the wxSTC_IME_* constants.
2151
+ # @param imeInteraction [Integer]
2152
+ # @return [void]
2153
+ def set_ime_interaction(imeInteraction) end
2154
+ alias_method :ime_interaction=, :set_ime_interaction
2155
+
2156
+ # Set the number of characters to have directly indexed categories.
2157
+ # @param countCharacters [Integer]
2158
+ # @return [void]
2159
+ def set_character_category_optimization(countCharacters) end
2160
+ alias_method :character_category_optimization=, :set_character_category_optimization
2161
+
2162
+ # Get the number of characters to have directly indexed categories.
2163
+ # @return [Integer]
2164
+ def get_character_category_optimization; end
2165
+ alias_method :character_category_optimization, :get_character_category_optimization
2166
+
2167
+ # Retrieve the caret line frame width.
2168
+ #
2169
+ # Width = 0 means this option is disabled.
2170
+ # @return [Integer]
2171
+ def get_caret_line_frame; end
2172
+ alias_method :caret_line_frame, :get_caret_line_frame
2173
+
2174
+ # Display the caret line framed.
2175
+ #
2176
+ # Set width != 0 to enable this option and width = 0 to disable it.
2177
+ # @param width [Integer]
2178
+ # @return [void]
2179
+ def set_caret_line_frame(width) end
2180
+ alias_method :caret_line_frame=, :set_caret_line_frame
2181
+
2182
+ # Count code units between two positions.
2183
+ # @param start [Integer]
2184
+ # @param end_ [Integer]
2185
+ # @return [Integer]
2186
+ def count_code_units(start, end_) end
2187
+
2188
+ # Get the code page used to interpret the bytes of the document as characters.
2189
+ # @return [Integer]
2190
+ def get_code_page; end
2191
+ alias_method :code_page, :get_code_page
2192
+
2193
+ # Sets the virtual space of the target start.
2194
+ # @param space [Integer]
2195
+ # @return [void]
2196
+ def set_target_start_virtual_space(space) end
2197
+ alias_method :target_start_virtual_space=, :set_target_start_virtual_space
2198
+
2199
+ # Get the virtual space of the target start.
2200
+ # @return [Integer]
2201
+ def get_target_start_virtual_space; end
2202
+ alias_method :target_start_virtual_space, :get_target_start_virtual_space
2203
+
2204
+ # Sets the virtual space of the target end.
2205
+ # @param space [Integer]
2206
+ # @return [void]
2207
+ def set_target_end_virtual_space(space) end
2208
+ alias_method :target_end_virtual_space=, :set_target_end_virtual_space
2209
+
2210
+ # Get the virtual space of the target end.
2211
+ # @return [Integer]
2212
+ def get_target_end_virtual_space; end
2213
+ alias_method :target_end_virtual_space, :get_target_end_virtual_space
2214
+
2215
+ # Get the style of fold display text.
2216
+ # @return [Integer]
2217
+ def fold_display_text_get_style; end
2218
+
2219
+ # Set the default fold display text.
2220
+ # @param text [String]
2221
+ # @return [void]
2222
+ def set_default_fold_display_text(text) end
2223
+ alias_method :default_fold_display_text=, :set_default_fold_display_text
2224
+
2225
+ # Get the default fold display text.
2226
+ # @return [String]
2227
+ def get_default_fold_display_text; end
2228
+ alias_method :default_fold_display_text, :get_default_fold_display_text
2229
+
2230
+ # Sets the degree of caching of layout information.
2231
+ #
2232
+ # The input should be one of the wxSTC_CACHE_* constants.
2233
+ # @param cacheMode [Integer]
2234
+ # @return [void]
2235
+ def set_layout_cache(cacheMode) end
2236
+ alias_method :layout_cache=, :set_layout_cache
2237
+
2238
+ # How many phases is drawing done in?
2239
+ #
2240
+ # The return value will be one of the wxSTC_PHASES_* constants.
2241
+ # @return [Integer]
2242
+ def get_phases_draw; end
2243
+ alias_method :phases_draw, :get_phases_draw
2244
+
2245
+ # In one phase draw, text is drawn in a series of rectangular blocks with no overlap.
2246
+ #
2247
+ # In two phase draw, text is drawn in a series of lines allowing runs to overlap horizontally. In multiple phase draw, each element is drawn over the whole drawing area, allowing text to overlap from one line to the next.
2248
+ # The input should be one of the wxSTC_PHASES_* constants.
2249
+ # @param phases [Integer]
2250
+ # @return [void]
2251
+ def set_phases_draw(phases) end
2252
+ alias_method :phases_draw=, :set_phases_draw
2253
+
2254
+ # Choose the quality level for text.
2255
+ #
2256
+ # The input should be one of the wxSTC_EFF_QUALITY_* constants.
2257
+ # <div class="wxrb-remark">
2258
+ # <b>Remark:</b>
2259
+ # <p>This method only has any effect with the WXMSW port and when technology has been set to {Wx::STC::STC_TECHNOLOGY_DIRECTWRITE}.
2260
+ # </p>
2261
+ # </div>
2262
+ # @param fontQuality [Integer]
2263
+ # @return [void]
2264
+ def set_font_quality(fontQuality) end
2265
+ alias_method :font_quality=, :set_font_quality
2266
+
2267
+ # Retrieve the quality level for text.
2268
+ #
2269
+ # The return value will be one of the wxSTC_EFF_QUALITY_* constants.
2270
+ # @return [Integer]
2271
+ def get_font_quality; end
2272
+ alias_method :font_quality, :get_font_quality
2273
+
2274
+ # Enable or disable accessibility.
2275
+ # @param accessibility [Integer]
2276
+ # @return [void]
2277
+ def set_accessibility(accessibility) end
2278
+ alias_method :accessibility=, :set_accessibility
2279
+
2280
+ # Report accessibility status.
2281
+ # @return [Integer]
2282
+ def get_accessibility; end
2283
+ alias_method :accessibility, :get_accessibility
2284
+
2285
+ # Reverse order of selected lines.
2286
+ # @return [void]
2287
+ def line_reverse; end
2288
+
2289
+ # Similar to BraceMatch, but matching starts at the explicit start position.
2290
+ # @param pos [Integer]
2291
+ # @param startPos [Integer]
2292
+ # @return [Integer]
2293
+ def brace_match_next(pos, startPos) end
2294
+
2295
+ # Get multi edge positions.
2296
+ # @param which [Integer]
2297
+ # @return [Integer]
2298
+ def get_multi_edge_column(which) end
2299
+ alias_method :multi_edge_column, :get_multi_edge_column
2300
+
2301
+ # Get which document options are set.
2302
+ # @return [Integer]
2303
+ def get_document_options; end
2304
+ alias_method :document_options, :get_document_options
2305
+
2306
+ # Set whether command events are sent to the container.
2307
+ # @param commandEvents [Boolean]
2308
+ # @return [void]
2309
+ def set_command_events(commandEvents) end
2310
+ alias_method :command_events=, :set_command_events
2311
+
2312
+ # Get whether command events are sent to the container.
2313
+ # @return [Boolean]
2314
+ def get_command_events; end
2315
+ alias_method :command_events, :get_command_events
2316
+
2317
+ # Change internal focus flag.
2318
+ # @param focus [Boolean]
2319
+ # @return [void]
2320
+ def set_stc_focus(focus) end
2321
+ alias_method :stc_focus=, :set_stc_focus
2322
+
2323
+ # Get internal focus flag.
2324
+ # @return [Boolean]
2325
+ def get_stc_focus; end
2326
+ alias_method :stc_focus, :get_stc_focus
2327
+
2328
+ # Given a valid document position, return a position that differs in a number of UTF-16 code units.
2329
+ #
2330
+ # Returned value is always between 0 and last position in document. The result may point half way (2 bytes) inside a non-BMP character.
2331
+ # @param pos [Integer]
2332
+ # @param relative [Integer]
2333
+ # @return [Integer]
2334
+ def position_relative_code_units(pos, relative) end
2335
+
2336
+ # Get whether or not regular caret moves will extend or reduce the selection.
2337
+ # @return [Boolean]
2338
+ def get_move_extends_selection; end
2339
+ alias_method :move_extends_selection, :get_move_extends_selection
2340
+
2341
+ # Returns the virtual space at the start of the selection.
2342
+ # @param selection [Integer]
2343
+ # @return [Integer]
2344
+ def get_selection_n_start_virtual_space(selection) end
2345
+ alias_method :selection_n_start_virtual_space, :get_selection_n_start_virtual_space
2346
+
2347
+ # Returns the virtual space at the end of the selection.
2348
+ # @param selection [Integer]
2349
+ # @return [Integer]
2350
+ def get_selection_n_end_virtual_space(selection) end
2351
+ alias_method :selection_n_end_virtual_space, :get_selection_n_end_virtual_space
2352
+
2353
+ # Set the technology used.
2354
+ #
2355
+ # <div class="wxrb-remark">
2356
+ # <b>Remark:</b>
2357
+ # <p>For the WXMSW port, the input can be either {Wx::STC::STC_TECHNOLOGY_DEFAULT} or {Wx::STC::STC_TECHNOLOGY_DIRECTWRITE}. With other ports, this method has no effect.
2358
+ # </p>
2359
+ # </div>
2360
+ # @param technology [Integer]
2361
+ # @return [void]
2362
+ def set_technology(technology) end
2363
+ alias_method :technology=, :set_technology
2364
+
2365
+ # Get the tech.
2366
+ #
2367
+ # The return value will be one of the wxSTC_TECHNOLOGY_* constants.
2368
+ # @return [Integer]
2369
+ def get_technology; end
2370
+ alias_method :technology, :get_technology
2371
+
2372
+ # Set the end of line annotation text for a line.
2373
+ # @param line [Integer]
2374
+ # @param text [String]
2375
+ # @return [void]
2376
+ def eol_annotation_set_text(line, text) end
2377
+
2378
+ # Get the end of line annotation text for a line.
2379
+ # @param line [Integer]
2380
+ # @return [String]
2381
+ def eol_annotation_get_text(line) end
2382
+
2383
+ # Set the style number for the end of line annotations for a line.
2384
+ # @param line [Integer]
2385
+ # @param style [Integer]
2386
+ # @return [void]
2387
+ def eol_annotation_set_style(line, style) end
2388
+
2389
+ # Get the style number for the end of line annotations for a line.
2390
+ # @param line [Integer]
2391
+ # @return [Integer]
2392
+ def eol_annotation_get_style(line) end
2393
+
2394
+ # Clear the end of annotations from all lines.
2395
+ # @return [void]
2396
+ def eol_annotation_clear_all; end
2397
+
2398
+ # Set the visibility for the end of line annotations for a view.
2399
+ # @param visible [Integer]
2400
+ # @return [void]
2401
+ def eol_annotation_set_visible(visible) end
2402
+
2403
+ # Get the visibility for the end of line annotations for a view.
2404
+ # @return [Integer]
2405
+ def eol_annotation_get_visible; end
2406
+
2407
+ # Get the start of the range of style numbers used for end of line annotations.
2408
+ # @param style [Integer]
2409
+ # @return [void]
2410
+ def eol_annotation_set_style_offset(style) end
2411
+
2412
+ # Get the start of the range of style numbers used for end of line annotations.
2413
+ # @return [Integer]
2414
+ def eol_annotation_get_style_offset; end
2415
+
2416
+ # Retrieve the number of named styles for the lexer.
2417
+ # @return [Integer]
2418
+ def get_named_styles; end
2419
+ alias_method :named_styles, :get_named_styles
2420
+
2421
+ # Retrieve the name of a style.
2422
+ #
2423
+ # Result is NUL-terminated.
2424
+ # @param style [Integer]
2425
+ # @return [String]
2426
+ def name_of_style(style) end
2427
+
2428
+ # Retrieve a ' ' separated list of style tags like "literal quoted string".
2429
+ #
2430
+ # Result is NUL-terminated.
2431
+ # @param style [Integer]
2432
+ # @return [String]
2433
+ def tags_of_style(style) end
2434
+
2435
+ # Retrieve a description of a style.
2436
+ #
2437
+ # Result is NUL-terminated.
2438
+ # @param style [Integer]
2439
+ # @return [String]
2440
+ def description_of_style(style) end
2441
+
2442
+ # Set the lexer from an ILexer*.
2443
+ # @param ilexer [Object]
2444
+ # @return [void]
2445
+ def set_i_lexer(ilexer) end
2446
+ alias_method :i_lexer=, :set_i_lexer
2447
+
2448
+ # Highlight the characters at two positions.
2449
+ # @param posA [Integer]
2450
+ # @param posB [Integer]
2451
+ # @return [void]
2452
+ def brace_highlight(posA, posB) end
2453
+
2454
+ # Use specified indicator to highlight matching braces instead of changing their style.
2455
+ # @param useSetting [Boolean]
2456
+ # @param indicator [Integer]
2457
+ # @return [void]
2458
+ def brace_highlight_indicator(useSetting, indicator) end
2459
+
2460
+ # Highlight the character at a position indicating there is no matching brace.
2461
+ # @param pos [Integer]
2462
+ # @return [void]
2463
+ def brace_bad_light(pos) end
2464
+
2465
+ # Use specified indicator to highlight non matching brace instead of changing its style.
2466
+ # @param useSetting [Boolean]
2467
+ # @param indicator [Integer]
2468
+ # @return [void]
2469
+ def brace_bad_light_indicator(useSetting, indicator) end
2470
+
2471
+ # Find the position of a matching brace or {Wx::STC::STC_INVALID_POSITION} if no match.
2472
+ #
2473
+ # The maxReStyle must be 0 for now. It may be defined in a future release.
2474
+ # @param pos [Integer]
2475
+ # @param maxReStyle [Integer]
2476
+ # @return [Integer]
2477
+ def brace_match(pos, maxReStyle=0) end
2478
+
2479
+ # Change the visible size of a tab to be a multiple of the width of a space character.
2480
+ # @param tabWidth [Integer]
2481
+ # @return [void]
2482
+ def set_tab_width(tabWidth) end
2483
+ alias_method :tab_width=, :set_tab_width
2484
+
2485
+ # Retrieve the visible size of a tab.
2486
+ # @return [Integer]
2487
+ def get_tab_width; end
2488
+ alias_method :tab_width, :get_tab_width
2489
+
2490
+ # Clear explicit tabstops on a line.
2491
+ # @param line [Integer]
2492
+ # @return [void]
2493
+ def clear_tab_stops(line) end
2494
+
2495
+ # Add an explicit tab stop for a line.
2496
+ # @param line [Integer]
2497
+ # @param x [Integer]
2498
+ # @return [void]
2499
+ def add_tab_stop(line, x) end
2500
+
2501
+ # Find the next explicit tab stop position on a line after a position.
2502
+ # @param line [Integer]
2503
+ # @param x [Integer]
2504
+ # @return [Integer]
2505
+ def get_next_tab_stop(line, x) end
2506
+ alias_method :next_tab_stop, :get_next_tab_stop
2507
+
2508
+ # Set the number of spaces used for one level of indentation.
2509
+ # @param indentSize [Integer]
2510
+ # @return [void]
2511
+ def set_indent(indentSize) end
2512
+ alias_method :indent=, :set_indent
2513
+
2514
+ # Retrieve indentation size.
2515
+ # @return [Integer]
2516
+ def get_indent; end
2517
+ alias_method :indent, :get_indent
2518
+
2519
+ # Indentation will only use space characters if useTabs is false, otherwise it will use a combination of tabs and spaces.
2520
+ # @param useTabs [Boolean]
2521
+ # @return [void]
2522
+ def set_use_tabs(useTabs) end
2523
+ alias_method :use_tabs=, :set_use_tabs
2524
+
2525
+ # Retrieve whether tabs will be used in indentation.
2526
+ # @return [Boolean]
2527
+ def get_use_tabs; end
2528
+ alias_method :use_tabs, :get_use_tabs
2529
+
2530
+ # Change the indentation of a line to a number of columns.
2531
+ # @param line [Integer]
2532
+ # @param indentation [Integer]
2533
+ # @return [void]
2534
+ def set_line_indentation(line, indentation) end
2535
+
2536
+ # Retrieve the number of columns that a line is indented.
2537
+ # @param line [Integer]
2538
+ # @return [Integer]
2539
+ def get_line_indentation(line) end
2540
+ alias_method :line_indentation, :get_line_indentation
2541
+
2542
+ # Retrieve the position before the first non indentation character on a line.
2543
+ # @param line [Integer]
2544
+ # @return [Integer]
2545
+ def get_line_indent_position(line) end
2546
+ alias_method :line_indent_position, :get_line_indent_position
2547
+
2548
+ # Show or hide indentation guides.
2549
+ #
2550
+ # The input should be one of the wxSTC_IV_* constants.
2551
+ # @param indentView [Integer]
2552
+ # @return [void]
2553
+ def set_indentation_guides(indentView) end
2554
+ alias_method :indentation_guides=, :set_indentation_guides
2555
+
2556
+ # Are the indentation guides visible?
2557
+ #
2558
+ # The return value will be one of the wxSTC_IV_* constants.
2559
+ # @return [Integer]
2560
+ def get_indentation_guides; end
2561
+ alias_method :indentation_guides, :get_indentation_guides
2562
+
2563
+ # Set the highlighted indentation guide column.
2564
+ #
2565
+ # 0 = no highlighted guide.
2566
+ # @param column [Integer]
2567
+ # @return [void]
2568
+ def set_highlight_guide(column) end
2569
+ alias_method :highlight_guide=, :set_highlight_guide
2570
+
2571
+ # Get the highlighted indentation guide column.
2572
+ # @return [Integer]
2573
+ def get_highlight_guide; end
2574
+ alias_method :highlight_guide, :get_highlight_guide
2575
+
2576
+ # Sets whether a tab pressed when caret is within indentation indents.
2577
+ # @param tabIndents [Boolean]
2578
+ # @return [void]
2579
+ def set_tab_indents(tabIndents) end
2580
+ alias_method :tab_indents=, :set_tab_indents
2581
+
2582
+ # Does a tab pressed when caret is within indentation indent?
2583
+ # @return [Boolean]
2584
+ def get_tab_indents; end
2585
+ alias_method :tab_indents, :get_tab_indents
2586
+
2587
+ # Sets whether a backspace pressed when caret is within indentation unindents.
2588
+ # @param bsUnIndents [Boolean]
2589
+ # @return [void]
2590
+ def set_back_space_un_indents(bsUnIndents) end
2591
+ alias_method :back_space_un_indents=, :set_back_space_un_indents
2592
+
2593
+ # Does a backspace pressed when caret is within indentation unindent?
2594
+ # @return [Boolean]
2595
+ def get_back_space_un_indents; end
2596
+ alias_method :back_space_un_indents, :get_back_space_un_indents
2597
+
2598
+ # Retrieve the line number at which a particular marker is located.
2599
+ # @param markerHandle [Integer]
2600
+ # @return [Integer]
2601
+ def marker_line_from_handle(markerHandle) end
2602
+
2603
+ # Delete a marker.
2604
+ # @param markerHandle [Integer]
2605
+ # @return [void]
2606
+ def marker_delete_handle(markerHandle) end
2607
+
2608
+ # Set the symbol used for a particular marker number, and optionally the fore and background colours.
2609
+ #
2610
+ # The second argument should be one of the wxSTC_MARK_* constants.
2611
+ # @param markerNumber [Integer]
2612
+ # @param markerSymbol [Integer]
2613
+ # @param foreground [Wx::Colour,String,Symbol]
2614
+ # @param background [Wx::Colour,String,Symbol]
2615
+ # @return [void]
2616
+ def marker_define(markerNumber, markerSymbol, foreground=Wx::NULL_COLOUR, background=Wx::NULL_COLOUR) end
2617
+
2618
+ # Set the foreground colour used for a particular marker number.
2619
+ # @param markerNumber [Integer]
2620
+ # @param fore [Wx::Colour,String,Symbol]
2621
+ # @return [void]
2622
+ def marker_set_foreground(markerNumber, fore) end
2623
+
2624
+ # Set the background colour used for a particular marker number.
2625
+ # @param markerNumber [Integer]
2626
+ # @param back [Wx::Colour,String,Symbol]
2627
+ # @return [void]
2628
+ def marker_set_background(markerNumber, back) end
2629
+
2630
+ # Set the background colour used for a particular marker number when its folding block is selected.
2631
+ # @param markerNumber [Integer]
2632
+ # @param back [Wx::Colour,String,Symbol]
2633
+ # @return [void]
2634
+ def marker_set_background_selected(markerNumber, back) end
2635
+
2636
+ # Enable/disable highlight for current folding block (smallest one that contains the caret).
2637
+ # @param enabled [Boolean]
2638
+ # @return [void]
2639
+ def marker_enable_highlight(enabled) end
2640
+
2641
+ # Add a marker to a line, returning an ID which can be used to find or delete the marker.
2642
+ # @param line [Integer]
2643
+ # @param markerNumber [Integer]
2644
+ # @return [Integer]
2645
+ def marker_add(line, markerNumber) end
2646
+
2647
+ # Delete a marker from a line.
2648
+ # @param line [Integer]
2649
+ # @param markerNumber [Integer]
2650
+ # @return [void]
2651
+ def marker_delete(line, markerNumber) end
2652
+
2653
+ # Delete all markers with a particular number from all lines.
2654
+ # @param markerNumber [Integer]
2655
+ # @return [void]
2656
+ def marker_delete_all(markerNumber) end
2657
+
2658
+ # Get a bit mask of all the markers set on a line.
2659
+ # @param line [Integer]
2660
+ # @return [Integer]
2661
+ def marker_get(line) end
2662
+
2663
+ # Find the next line at or after lineStart that includes a marker in mask.
2664
+ #
2665
+ # Return -1 when no more lines.
2666
+ # @param lineStart [Integer]
2667
+ # @param markerMask [Integer]
2668
+ # @return [Integer]
2669
+ def marker_next(lineStart, markerMask) end
2670
+
2671
+ # Find the previous line before lineStart that includes a marker in mask.
2672
+ # @param lineStart [Integer]
2673
+ # @param markerMask [Integer]
2674
+ # @return [Integer]
2675
+ def marker_previous(lineStart, markerMask) end
2676
+
2677
+ # Add a set of markers to a line.
2678
+ # @param line [Integer]
2679
+ # @param markerSet [Integer]
2680
+ # @return [void]
2681
+ def marker_add_set(line, markerSet) end
2682
+
2683
+ # Set the alpha used for a marker that is drawn in the text area, not the margin.
2684
+ # @param markerNumber [Integer]
2685
+ # @param alpha [Integer]
2686
+ # @return [void]
2687
+ def marker_set_alpha(markerNumber, alpha) end
2688
+
2689
+ # Which symbol was defined for markerNumber with MarkerDefine.
2690
+ #
2691
+ # The return value will be one of the wxSTC_MARK_* constants.
2692
+ # @param markerNumber [Integer]
2693
+ # @return [Integer]
2694
+ def get_marker_symbol_defined(markerNumber) end
2695
+ alias_method :marker_symbol_defined, :get_marker_symbol_defined
2696
+
2697
+ # Set the width for future RGBA image data.
2698
+ # @param width [Integer]
2699
+ # @return [void]
2700
+ def rgba_image_set_width(width) end
2701
+
2702
+ # Set the height for future RGBA image data.
2703
+ # @param height [Integer]
2704
+ # @return [void]
2705
+ def rgba_image_set_height(height) end
2706
+
2707
+ # Set the scale factor in percent for future RGBA image data.
2708
+ # @param scalePercent [Integer]
2709
+ # @return [void]
2710
+ def rgba_image_set_scale(scalePercent) end
2711
+
2712
+ # Set an indicator to plain, squiggle or TT.
2713
+ #
2714
+ # The second argument should be one of the wxSTC_INDIC_* constants.
2715
+ # @param indicator [Integer]
2716
+ # @param indicatorStyle [Integer]
2717
+ # @return [void]
2718
+ def indicator_set_style(indicator, indicatorStyle) end
2719
+
2720
+ # Retrieve the style of an indicator.
2721
+ #
2722
+ # The return value will be one of the wxSTC_INDIC_* constants.
2723
+ # @param indicator [Integer]
2724
+ # @return [Integer]
2725
+ def indicator_get_style(indicator) end
2726
+
2727
+ # Set the foreground colour of an indicator.
2728
+ # @param indicator [Integer]
2729
+ # @param fore [Wx::Colour,String,Symbol]
2730
+ # @return [void]
2731
+ def indicator_set_foreground(indicator, fore) end
2732
+
2733
+ # Retrieve the foreground colour of an indicator.
2734
+ # @param indicator [Integer]
2735
+ # @return [Wx::Colour]
2736
+ def indicator_get_foreground(indicator) end
2737
+
2738
+ # Set an indicator to draw under text or over(default).
2739
+ # @param indicator [Integer]
2740
+ # @param under [Boolean]
2741
+ # @return [void]
2742
+ def indicator_set_under(indicator, under) end
2743
+
2744
+ # Retrieve whether indicator drawn under or over text.
2745
+ # @param indicator [Integer]
2746
+ # @return [Boolean]
2747
+ def indicator_get_under(indicator) end
2748
+
2749
+ # Set a hover indicator to plain, squiggle or TT.
2750
+ # @param indicator [Integer]
2751
+ # @param indicatorStyle [Integer]
2752
+ # @return [void]
2753
+ def indicator_set_hover_style(indicator, indicatorStyle) end
2754
+
2755
+ # Retrieve the hover style of an indicator.
2756
+ # @param indicator [Integer]
2757
+ # @return [Integer]
2758
+ def indicator_get_hover_style(indicator) end
2759
+
2760
+ # Set the foreground hover colour of an indicator.
2761
+ # @param indicator [Integer]
2762
+ # @param fore [Wx::Colour,String,Symbol]
2763
+ # @return [void]
2764
+ def indicator_set_hover_foreground(indicator, fore) end
2765
+
2766
+ # Retrieve the foreground hover colour of an indicator.
2767
+ # @param indicator [Integer]
2768
+ # @return [Wx::Colour]
2769
+ def indicator_get_hover_foreground(indicator) end
2770
+
2771
+ # Set the attributes of an indicator.
2772
+ #
2773
+ # The second argument should be a bit list containing one or more of the wxSTC_INDICFLAG_* constants.
2774
+ # @param indicator [Integer]
2775
+ # @param flags [Integer]
2776
+ # @return [void]
2777
+ def indicator_set_flags(indicator, flags) end
2778
+
2779
+ # Retrieve the attributes of an indicator.
2780
+ #
2781
+ # The return value will be a bit list containing one or more of the wxSTC_INDICFLAG_* constants.
2782
+ # @param indicator [Integer]
2783
+ # @return [Integer]
2784
+ def indicator_get_flags(indicator) end
2785
+
2786
+ # Set the indicator used for IndicatorFillRange and IndicatorClearRange.
2787
+ # @param indicator [Integer]
2788
+ # @return [void]
2789
+ def set_indicator_current(indicator) end
2790
+ alias_method :indicator_current=, :set_indicator_current
2791
+
2792
+ # Get the current indicator.
2793
+ # @return [Integer]
2794
+ def get_indicator_current; end
2795
+ alias_method :indicator_current, :get_indicator_current
2796
+
2797
+ # Set the value used for IndicatorFillRange.
2798
+ # @param value [Integer]
2799
+ # @return [void]
2800
+ def set_indicator_value(value) end
2801
+ alias_method :indicator_value=, :set_indicator_value
2802
+
2803
+ # Get the current indicator value.
2804
+ # @return [Integer]
2805
+ def get_indicator_value; end
2806
+ alias_method :indicator_value, :get_indicator_value
2807
+
2808
+ # Turn a indicator on over a range.
2809
+ # @param start [Integer]
2810
+ # @param lengthFill [Integer]
2811
+ # @return [void]
2812
+ def indicator_fill_range(start, lengthFill) end
2813
+
2814
+ # Turn a indicator off over a range.
2815
+ # @param start [Integer]
2816
+ # @param lengthClear [Integer]
2817
+ # @return [void]
2818
+ def indicator_clear_range(start, lengthClear) end
2819
+
2820
+ # Are any indicators present at pos?
2821
+ # @param pos [Integer]
2822
+ # @return [Integer]
2823
+ def indicator_all_on_for(pos) end
2824
+
2825
+ # What value does a particular indicator have at a position?
2826
+ # @param indicator [Integer]
2827
+ # @param pos [Integer]
2828
+ # @return [Integer]
2829
+ def indicator_value_at(indicator, pos) end
2830
+
2831
+ # Where does a particular indicator start?
2832
+ # @param indicator [Integer]
2833
+ # @param pos [Integer]
2834
+ # @return [Integer]
2835
+ def indicator_start(indicator, pos) end
2836
+
2837
+ # Where does a particular indicator end?
2838
+ # @param indicator [Integer]
2839
+ # @param pos [Integer]
2840
+ # @return [Integer]
2841
+ def indicator_end(indicator, pos) end
2842
+
2843
+ # Set the alpha fill colour of the given indicator.
2844
+ # @param indicator [Integer]
2845
+ # @param alpha [Integer]
2846
+ # @return [void]
2847
+ def indicator_set_alpha(indicator, alpha) end
2848
+
2849
+ # Get the alpha fill colour of the given indicator.
2850
+ # @param indicator [Integer]
2851
+ # @return [Integer]
2852
+ def indicator_get_alpha(indicator) end
2853
+
2854
+ # Set the alpha outline colour of the given indicator.
2855
+ # @param indicator [Integer]
2856
+ # @param alpha [Integer]
2857
+ # @return [void]
2858
+ def indicator_set_outline_alpha(indicator, alpha) end
2859
+
2860
+ # Get the alpha outline colour of the given indicator.
2861
+ # @param indicator [Integer]
2862
+ # @return [Integer]
2863
+ def indicator_get_outline_alpha(indicator) end
2864
+
2865
+ # Display a auto-completion list.
2866
+ #
2867
+ # The lengthEntered parameter indicates how many characters before the caret should be used to provide context.
2868
+ # @param lengthEntered [Integer]
2869
+ # @param itemList [String]
2870
+ # @return [void]
2871
+ def auto_comp_show(lengthEntered, itemList) end
2872
+
2873
+ # Remove the auto-completion list from the screen.
2874
+ # @return [void]
2875
+ def auto_comp_cancel; end
2876
+
2877
+ # Is there an auto-completion list visible?
2878
+ # @return [Boolean]
2879
+ def auto_comp_active; end
2880
+
2881
+ # Retrieve the position of the caret when the auto-completion list was displayed.
2882
+ # @return [Integer]
2883
+ def auto_comp_pos_start; end
2884
+
2885
+ # User has selected an item so remove the list and insert the selection.
2886
+ # @return [void]
2887
+ def auto_comp_complete; end
2888
+
2889
+ # Define a set of character that when typed cancel the auto-completion list.
2890
+ # @param characterSet [String]
2891
+ # @return [void]
2892
+ def auto_comp_stops(characterSet) end
2893
+
2894
+ # Change the separator character in the string setting up an auto-completion list.
2895
+ #
2896
+ # Default is space but can be changed if items contain space.
2897
+ # @param separatorCharacter [Integer]
2898
+ # @return [void]
2899
+ def auto_comp_set_separator(separatorCharacter) end
2900
+
2901
+ # Retrieve the auto-completion list separator character.
2902
+ # @return [Integer]
2903
+ def auto_comp_get_separator; end
2904
+
2905
+ # Select the item in the auto-completion list that starts with a string.
2906
+ # @param select [String]
2907
+ # @return [void]
2908
+ def auto_comp_select(select) end
2909
+
2910
+ # Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created.
2911
+ # @param cancel [Boolean]
2912
+ # @return [void]
2913
+ def auto_comp_set_cancel_at_start(cancel) end
2914
+
2915
+ # Retrieve whether auto-completion cancelled by backspacing before start.
2916
+ # @return [Boolean]
2917
+ def auto_comp_get_cancel_at_start; end
2918
+
2919
+ # Define a set of characters that when typed will cause the autocompletion to choose the selected item.
2920
+ # @param characterSet [String]
2921
+ # @return [void]
2922
+ def auto_comp_set_fill_ups(characterSet) end
2923
+
2924
+ # Should a single item auto-completion list automatically choose the item.
2925
+ # @param chooseSingle [Boolean]
2926
+ # @return [void]
2927
+ def auto_comp_set_choose_single(chooseSingle) end
2928
+
2929
+ # Retrieve whether a single item auto-completion list automatically choose the item.
2930
+ # @return [Boolean]
2931
+ def auto_comp_get_choose_single; end
2932
+
2933
+ # Set whether case is significant when performing auto-completion searches.
2934
+ # @param ignoreCase [Boolean]
2935
+ # @return [void]
2936
+ def auto_comp_set_ignore_case(ignoreCase) end
2937
+
2938
+ # Retrieve state of ignore case flag.
2939
+ # @return [Boolean]
2940
+ def auto_comp_get_ignore_case; end
2941
+
2942
+ # Set whether or not autocompletion is hidden automatically when nothing matches.
2943
+ # @param autoHide [Boolean]
2944
+ # @return [void]
2945
+ def auto_comp_set_auto_hide(autoHide) end
2946
+
2947
+ # Retrieve whether or not autocompletion is hidden automatically when nothing matches.
2948
+ # @return [Boolean]
2949
+ def auto_comp_get_auto_hide; end
2950
+
2951
+ # Set whether or not autocompletion deletes any word characters after the inserted text upon completion.
2952
+ # @param dropRestOfWord [Boolean]
2953
+ # @return [void]
2954
+ def auto_comp_set_drop_rest_of_word(dropRestOfWord) end
2955
+
2956
+ # Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion.
2957
+ # @return [Boolean]
2958
+ def auto_comp_get_drop_rest_of_word; end
2959
+
2960
+ # Register an image for use in autocompletion lists.
2961
+ # @param type [Integer]
2962
+ # @param bmp [Wx::Bitmap]
2963
+ # @return [void]
2964
+ def register_image(type, bmp) end
2965
+
2966
+ # Clear all the registered images.
2967
+ # @return [void]
2968
+ def clear_registered_images; end
2969
+
2970
+ # Retrieve the auto-completion list type-separator character.
2971
+ # @return [Integer]
2972
+ def auto_comp_get_type_separator; end
2973
+
2974
+ # Change the type-separator character in the string setting up an auto-completion list.
2975
+ #
2976
+ # Default is '?' but can be changed if items contain '?'.
2977
+ # @param separatorCharacter [Integer]
2978
+ # @return [void]
2979
+ def auto_comp_set_type_separator(separatorCharacter) end
2980
+
2981
+ # Set the maximum width, in characters, of auto-completion and user lists.
2982
+ #
2983
+ # Set to 0 to autosize to fit longest item, which is the default.
2984
+ # @param characterCount [Integer]
2985
+ # @return [void]
2986
+ def auto_comp_set_max_width(characterCount) end
2987
+
2988
+ # Get the maximum width, in characters, of auto-completion and user lists.
2989
+ # @return [Integer]
2990
+ def auto_comp_get_max_width; end
2991
+
2992
+ # Set the maximum height, in rows, of auto-completion and user lists.
2993
+ #
2994
+ # The default is 5 rows.
2995
+ # @param rowCount [Integer]
2996
+ # @return [void]
2997
+ def auto_comp_set_max_height(rowCount) end
2998
+
2999
+ # Set the maximum height, in rows, of auto-completion and user lists.
3000
+ # @return [Integer]
3001
+ def auto_comp_get_max_height; end
3002
+
3003
+ # Get currently selected item position in the auto-completion list.
3004
+ # @return [Integer]
3005
+ def auto_comp_get_current; end
3006
+
3007
+ # Get currently selected item text in the auto-completion list.
3008
+ # @return [String]
3009
+ def auto_comp_get_current_text; end
3010
+
3011
+ # Set auto-completion case insensitive behaviour to either prefer case-sensitive matches or have no preference.
3012
+ #
3013
+ # The input should be one of the wxSTC_CASEINSENSITIVEBEHAVIOUR_* constants.
3014
+ # @param behaviour [Integer]
3015
+ # @return [void]
3016
+ def auto_comp_set_case_insensitive_behaviour(behaviour) end
3017
+
3018
+ # Get auto-completion case insensitive behaviour.
3019
+ #
3020
+ # The return value will be one of the wxSTC_CASEINSENSITIVEBEHAVIOUR_* constants.
3021
+ # @return [Integer]
3022
+ def auto_comp_get_case_insensitive_behaviour; end
3023
+
3024
+ # Change the effect of autocompleting when there are multiple selections.
3025
+ #
3026
+ # The input should be one of the wxSTC_MULTIAUTOC_* constants.
3027
+ # @param multi [Integer]
3028
+ # @return [void]
3029
+ def auto_comp_set_multi(multi) end
3030
+
3031
+ # Retrieve the effect of autocompleting when there are multiple selections.
3032
+ #
3033
+ # The return value will be one of the wxSTC_MULTIAUTOC_* constants.
3034
+ # @return [Integer]
3035
+ def auto_comp_get_multi; end
3036
+
3037
+ # Set the way autocompletion lists are ordered.
3038
+ #
3039
+ # The input should be one of the wxSTC_ORDER_* constants.
3040
+ # @param order [Integer]
3041
+ # @return [void]
3042
+ def auto_comp_set_order(order) end
3043
+
3044
+ # Get the way autocompletion lists are ordered.
3045
+ #
3046
+ # The return value will be one of the wxSTC_ORDER_* constants.
3047
+ # @return [Integer]
3048
+ def auto_comp_get_order; end
3049
+
3050
+ # Display a list of strings and send notification when user chooses one.
3051
+ # @param listType [Integer]
3052
+ # @param itemList [String]
3053
+ # @return [void]
3054
+ def user_list_show(listType, itemList) end
3055
+
3056
+ # Show a call tip containing a definition near position pos.
3057
+ # @param pos [Integer]
3058
+ # @param definition [String]
3059
+ # @return [void]
3060
+ def call_tip_show(pos, definition) end
3061
+
3062
+ # Remove the call tip from the screen.
3063
+ # @return [void]
3064
+ def call_tip_cancel; end
3065
+
3066
+ # Is there an active call tip?
3067
+ # @return [Boolean]
3068
+ def call_tip_active; end
3069
+
3070
+ # Retrieve the position where the caret was before displaying the call tip.
3071
+ # @return [Integer]
3072
+ def call_tip_pos_at_start; end
3073
+
3074
+ # Set the start position in order to change when backspacing removes the calltip.
3075
+ # @param posStart [Integer]
3076
+ # @return [void]
3077
+ def call_tip_set_pos_at_start(posStart) end
3078
+
3079
+ # Highlight a segment of the definition.
3080
+ # @param highlightStart [Integer]
3081
+ # @param highlightEnd [Integer]
3082
+ # @return [void]
3083
+ def call_tip_set_highlight(highlightStart, highlightEnd) end
3084
+
3085
+ # Set the background colour for the call tip.
3086
+ # @param back [Wx::Colour,String,Symbol]
3087
+ # @return [void]
3088
+ def call_tip_set_background(back) end
3089
+
3090
+ # Set the foreground colour for the call tip.
3091
+ # @param fore [Wx::Colour,String,Symbol]
3092
+ # @return [void]
3093
+ def call_tip_set_foreground(fore) end
3094
+
3095
+ # Set the foreground colour for the highlighted part of the call tip.
3096
+ # @param fore [Wx::Colour,String,Symbol]
3097
+ # @return [void]
3098
+ def call_tip_set_foreground_highlight(fore) end
3099
+
3100
+ # Enable use of {Wx::STC::STC_STYLE_CALLTIP} and set call tip tab size in pixels.
3101
+ # @param tabSize [Integer]
3102
+ # @return [void]
3103
+ def call_tip_use_style(tabSize) end
3104
+
3105
+ # Set position of calltip, above or below text.
3106
+ # @param above [Boolean]
3107
+ # @return [void]
3108
+ def call_tip_set_position(above) end
3109
+
3110
+ # Move caret down one line.
3111
+ # @return [void]
3112
+ def line_down; end
3113
+
3114
+ # Move caret down one line extending selection to new caret position.
3115
+ # @return [void]
3116
+ def line_down_extend; end
3117
+
3118
+ # Move caret up one line.
3119
+ # @return [void]
3120
+ def line_up; end
3121
+
3122
+ # Move caret up one line extending selection to new caret position.
3123
+ # @return [void]
3124
+ def line_up_extend; end
3125
+
3126
+ # Move caret left one character.
3127
+ # @return [void]
3128
+ def char_left; end
3129
+
3130
+ # Move caret left one character extending selection to new caret position.
3131
+ # @return [void]
3132
+ def char_left_extend; end
3133
+
3134
+ # Move caret right one character.
3135
+ # @return [void]
3136
+ def char_right; end
3137
+
3138
+ # Move caret right one character extending selection to new caret position.
3139
+ # @return [void]
3140
+ def char_right_extend; end
3141
+
3142
+ # Move caret left one word.
3143
+ # @return [void]
3144
+ def word_left; end
3145
+
3146
+ # Move caret left one word extending selection to new caret position.
3147
+ # @return [void]
3148
+ def word_left_extend; end
3149
+
3150
+ # Move caret right one word.
3151
+ # @return [void]
3152
+ def word_right; end
3153
+
3154
+ # Move caret right one word extending selection to new caret position.
3155
+ # @return [void]
3156
+ def word_right_extend; end
3157
+
3158
+ # Move caret to first position on line.
3159
+ # @return [void]
3160
+ def home; end
3161
+
3162
+ # Move caret to first position on line extending selection to new caret position.
3163
+ # @return [void]
3164
+ def home_extend; end
3165
+
3166
+ # Move caret to last position on line.
3167
+ # @return [void]
3168
+ def line_end; end
3169
+
3170
+ # Move caret to last position on line extending selection to new caret position.
3171
+ # @return [void]
3172
+ def line_end_extend; end
3173
+
3174
+ # Move caret to first position in document.
3175
+ # @return [void]
3176
+ def document_start; end
3177
+
3178
+ # Move caret to first position in document extending selection to new caret position.
3179
+ # @return [void]
3180
+ def document_start_extend; end
3181
+
3182
+ # Move caret to last position in document.
3183
+ # @return [void]
3184
+ def document_end; end
3185
+
3186
+ # Move caret to last position in document extending selection to new caret position.
3187
+ # @return [void]
3188
+ def document_end_extend; end
3189
+
3190
+ # Move caret one page up.
3191
+ # @return [void]
3192
+ def page_up; end
3193
+
3194
+ # Move caret one page up extending selection to new caret position.
3195
+ # @return [void]
3196
+ def page_up_extend; end
3197
+
3198
+ # Move caret one page down.
3199
+ # @return [void]
3200
+ def page_down; end
3201
+
3202
+ # Move caret one page down extending selection to new caret position.
3203
+ # @return [void]
3204
+ def page_down_extend; end
3205
+
3206
+ # Switch from insert to overtype mode or the reverse.
3207
+ # @return [void]
3208
+ def edit_toggle_overtype; end
3209
+
3210
+ # Cancel any modes such as call tip or auto-completion list display.
3211
+ # @return [void]
3212
+ def cancel; end
3213
+
3214
+ # Delete the selection or if no selection, the character before the caret.
3215
+ # @return [void]
3216
+ def delete_back; end
3217
+
3218
+ # If selection is empty or all on one line replace the selection with a tab character.
3219
+ #
3220
+ # If more than one line selected, indent the lines.
3221
+ # @return [void]
3222
+ def tab; end
3223
+
3224
+ # Dedent the selected lines.
3225
+ # @return [void]
3226
+ def back_tab; end
3227
+
3228
+ # Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
3229
+ # @return [void]
3230
+ def new_line; end
3231
+
3232
+ # Insert a Form Feed character.
3233
+ # @return [void]
3234
+ def form_feed; end
3235
+
3236
+ # Move caret to before first visible character on line.
3237
+ #
3238
+ # If already there move to first character on line.
3239
+ # @return [void]
3240
+ def vc_home; end
3241
+
3242
+ # Like VCHome but extending selection to new caret position.
3243
+ # @return [void]
3244
+ def vc_home_extend; end
3245
+
3246
+ # Delete the word to the left of the caret.
3247
+ # @return [void]
3248
+ def del_word_left; end
3249
+
3250
+ # Delete the word to the right of the caret.
3251
+ # @return [void]
3252
+ def del_word_right; end
3253
+
3254
+ # Delete the word to the right of the caret, but not the trailing non-word characters.
3255
+ # @return [void]
3256
+ def del_word_right_end; end
3257
+
3258
+ # Cut the line containing the caret.
3259
+ # @return [void]
3260
+ def line_cut; end
3261
+
3262
+ # Delete the line containing the caret.
3263
+ # @return [void]
3264
+ def line_delete; end
3265
+
3266
+ # Switch the current line with the previous.
3267
+ # @return [void]
3268
+ def line_transpose; end
3269
+
3270
+ # Duplicate the current line.
3271
+ # @return [void]
3272
+ def line_duplicate; end
3273
+
3274
+ # Transform the selection to lower case.
3275
+ # @return [void]
3276
+ def lower_case; end
3277
+
3278
+ # Transform the selection to upper case.
3279
+ # @return [void]
3280
+ def upper_case; end
3281
+
3282
+ # Scroll the document down, keeping the caret visible.
3283
+ # @return [void]
3284
+ def line_scroll_down; end
3285
+
3286
+ # Scroll the document up, keeping the caret visible.
3287
+ # @return [void]
3288
+ def line_scroll_up; end
3289
+
3290
+ # Delete the selection or if no selection, the character before the caret.
3291
+ #
3292
+ # Will not delete the character before at the start of a line.
3293
+ # @return [void]
3294
+ def delete_back_not_line; end
3295
+
3296
+ # Move caret to first position on display line.
3297
+ # @return [void]
3298
+ def home_display; end
3299
+
3300
+ # Move caret to first position on display line extending selection to new caret position.
3301
+ # @return [void]
3302
+ def home_display_extend; end
3303
+
3304
+ # Move caret to last position on display line.
3305
+ # @return [void]
3306
+ def line_end_display; end
3307
+
3308
+ # Move caret to last position on display line extending selection to new caret position.
3309
+ # @return [void]
3310
+ def line_end_display_extend; end
3311
+
3312
+ # Like Home but when word-wrap is enabled goes first to start of display line HomeDisplay, then to start of document line Home.
3313
+ # @return [void]
3314
+ def home_wrap; end
3315
+
3316
+ # Like HomeExtend but when word-wrap is enabled extends first to start of display line HomeDisplayExtend, then to start of document line HomeExtend.
3317
+ # @return [void]
3318
+ def home_wrap_extend; end
3319
+
3320
+ # Like LineEnd but when word-wrap is enabled goes first to end of display line LineEndDisplay, then to start of document line LineEnd.
3321
+ # @return [void]
3322
+ def line_end_wrap; end
3323
+
3324
+ # Like LineEndExtend but when word-wrap is enabled extends first to end of display line LineEndDisplayExtend, then to start of document line LineEndExtend.
3325
+ # @return [void]
3326
+ def line_end_wrap_extend; end
3327
+
3328
+ # Like VCHome but when word-wrap is enabled goes first to start of display line VCHomeDisplay, then behaves like VCHome.
3329
+ # @return [void]
3330
+ def vc_home_wrap; end
3331
+
3332
+ # Like VCHomeExtend but when word-wrap is enabled extends first to start of display line VCHomeDisplayExtend, then behaves like VCHomeExtend.
3333
+ # @return [void]
3334
+ def vc_home_wrap_extend; end
3335
+
3336
+ # Copy the line containing the caret.
3337
+ # @return [void]
3338
+ def line_copy; end
3339
+
3340
+ # Move to the previous change in capitalisation.
3341
+ # @return [void]
3342
+ def word_part_left; end
3343
+
3344
+ # Move to the previous change in capitalisation extending selection to new caret position.
3345
+ # @return [void]
3346
+ def word_part_left_extend; end
3347
+
3348
+ # Move to the change next in capitalisation.
3349
+ # @return [void]
3350
+ def word_part_right; end
3351
+
3352
+ # Move to the next change in capitalisation extending selection to new caret position.
3353
+ # @return [void]
3354
+ def word_part_right_extend; end
3355
+
3356
+ # Delete back from the current position to the start of the line.
3357
+ # @return [void]
3358
+ def del_line_left; end
3359
+
3360
+ # Delete forwards from the current position to the end of the line.
3361
+ # @return [void]
3362
+ def del_line_right; end
3363
+
3364
+ # Move caret down one paragraph (delimited by empty lines).
3365
+ # @return [void]
3366
+ def para_down; end
3367
+
3368
+ # Extend selection down one paragraph (delimited by empty lines).
3369
+ # @return [void]
3370
+ def para_down_extend; end
3371
+
3372
+ # Move caret up one paragraph (delimited by empty lines).
3373
+ # @return [void]
3374
+ def para_up; end
3375
+
3376
+ # Extend selection up one paragraph (delimited by empty lines).
3377
+ # @return [void]
3378
+ def para_up_extend; end
3379
+
3380
+ # Move caret down one line, extending rectangular selection to new caret position.
3381
+ # @return [void]
3382
+ def line_down_rect_extend; end
3383
+
3384
+ # Move caret up one line, extending rectangular selection to new caret position.
3385
+ # @return [void]
3386
+ def line_up_rect_extend; end
3387
+
3388
+ # Move caret left one character, extending rectangular selection to new caret position.
3389
+ # @return [void]
3390
+ def char_left_rect_extend; end
3391
+
3392
+ # Move caret right one character, extending rectangular selection to new caret position.
3393
+ # @return [void]
3394
+ def char_right_rect_extend; end
3395
+
3396
+ # Move caret to first position on line, extending rectangular selection to new caret position.
3397
+ # @return [void]
3398
+ def home_rect_extend; end
3399
+
3400
+ # Move caret to before first visible character on line.
3401
+ #
3402
+ # If already there move to first character on line. In either case, extend rectangular selection to new caret position.
3403
+ # @return [void]
3404
+ def vc_home_rect_extend; end
3405
+
3406
+ # Move caret to last position on line, extending rectangular selection to new caret position.
3407
+ # @return [void]
3408
+ def line_end_rect_extend; end
3409
+
3410
+ # Move caret one page up, extending rectangular selection to new caret position.
3411
+ # @return [void]
3412
+ def page_up_rect_extend; end
3413
+
3414
+ # Move caret one page down, extending rectangular selection to new caret position.
3415
+ # @return [void]
3416
+ def page_down_rect_extend; end
3417
+
3418
+ # Move caret to top of page, or one page up if already at top of page.
3419
+ # @return [void]
3420
+ def stuttered_page_up; end
3421
+
3422
+ # Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.
3423
+ # @return [void]
3424
+ def stuttered_page_up_extend; end
3425
+
3426
+ # Move caret to bottom of page, or one page down if already at bottom of page.
3427
+ # @return [void]
3428
+ def stuttered_page_down; end
3429
+
3430
+ # Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.
3431
+ # @return [void]
3432
+ def stuttered_page_down_extend; end
3433
+
3434
+ # Move caret left one word, position cursor at end of word.
3435
+ # @return [void]
3436
+ def word_left_end; end
3437
+
3438
+ # Move caret left one word, position cursor at end of word, extending selection to new caret position.
3439
+ # @return [void]
3440
+ def word_left_end_extend; end
3441
+
3442
+ # Move caret right one word, position cursor at end of word.
3443
+ # @return [void]
3444
+ def word_right_end; end
3445
+
3446
+ # Move caret right one word, position cursor at end of word, extending selection to new caret position.
3447
+ # @return [void]
3448
+ def word_right_end_extend; end
3449
+
3450
+ # Duplicate the selection.
3451
+ #
3452
+ # If selection empty duplicate the line containing the caret.
3453
+ # @return [void]
3454
+ def selection_duplicate; end
3455
+
3456
+ # Centre current line in window.
3457
+ # @return [void]
3458
+ def vertical_centre_caret; end
3459
+
3460
+ # Scroll to start of document.
3461
+ # @return [void]
3462
+ def scroll_to_start; end
3463
+
3464
+ # Scroll to end of document.
3465
+ # @return [void]
3466
+ def scroll_to_end; end
3467
+
3468
+ # Move caret to before first visible character on display line.
3469
+ #
3470
+ # If already there move to first character on display line.
3471
+ # @return [void]
3472
+ def vc_home_display; end
3473
+
3474
+ # Like VCHomeDisplay but extending selection to new caret position.
3475
+ # @return [void]
3476
+ def vc_home_display_extend; end
3477
+
3478
+ # When key+modifier combination keyDefinition is pressed perform sciCommand.
3479
+ #
3480
+ # The second argument should be a bit list containing one or more of the wxSTC_KEYMOD_* constants and the third argument should be one of the wxSTC_CMD_* constants.
3481
+ # @param key [Integer]
3482
+ # @param modifiers [Integer]
3483
+ # @param cmd [Integer]
3484
+ # @return [void]
3485
+ def cmd_key_assign(key, modifiers, cmd) end
3486
+
3487
+ # When key+modifier combination keyDefinition is pressed do nothing.
3488
+ #
3489
+ # The second argument should be a bit list containing one or more of the wxSTC_KEYMOD_* constants.
3490
+ # @param key [Integer]
3491
+ # @param modifiers [Integer]
3492
+ # @return [void]
3493
+ def cmd_key_clear(key, modifiers) end
3494
+
3495
+ # Drop all key mappings.
3496
+ # @return [void]
3497
+ def cmd_key_clear_all; end
3498
+
3499
+ # Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button on certain areas.
3500
+ #
3501
+ # The input should be one of the wxSTC_POPUP_* constants.
3502
+ # <div class="wxrb-remark">
3503
+ # <b>Remark:</b>
3504
+ # <p>When {Wx::ContextMenuEvent} is used to create a custom popup menu, this function should be called with {Wx::STC::STC_POPUP_NEVER}. Otherwise the default menu will be shown instead of the custom one.
3505
+ # </p>
3506
+ # </div>
3507
+ # @param popUpMode [Integer]
3508
+ # @return [void]
3509
+ def use_pop_up(popUpMode) end
3510
+
3511
+ # Start notifying the container of all key presses and commands.
3512
+ # @return [void]
3513
+ def start_record; end
3514
+
3515
+ # Stop notifying the container of all key presses and commands.
3516
+ # @return [void]
3517
+ def stop_record; end
3518
+
3519
+ # Sets the print magnification added to the point size of each style for printing.
3520
+ # @param magnification [Integer]
3521
+ # @return [void]
3522
+ def set_print_magnification(magnification) end
3523
+ alias_method :print_magnification=, :set_print_magnification
3524
+
3525
+ # Returns the print magnification.
3526
+ # @return [Integer]
3527
+ def get_print_magnification; end
3528
+ alias_method :print_magnification, :get_print_magnification
3529
+
3530
+ # Modify colours when printing for clearer printed text.
3531
+ #
3532
+ # The input should be one of the wxSTC_PRINT_* constants.
3533
+ # @param mode [Integer]
3534
+ # @return [void]
3535
+ def set_print_colour_mode(mode) end
3536
+ alias_method :print_colour_mode=, :set_print_colour_mode
3537
+
3538
+ # Returns the print colour mode.
3539
+ #
3540
+ # The return value will be one of the wxSTC_PRINT_* constants.
3541
+ # @return [Integer]
3542
+ def get_print_colour_mode; end
3543
+ alias_method :print_colour_mode, :get_print_colour_mode
3544
+
3545
+ # On Windows, will draw the document into a display context such as a printer.
3546
+ # @param doDraw [Boolean]
3547
+ # @param startPos [Integer]
3548
+ # @param endPos [Integer]
3549
+ # @param draw [Wx::DC]
3550
+ # @param target [Wx::DC]
3551
+ # @param renderRect [Wx::Rect]
3552
+ # @param pageRect [Wx::Rect]
3553
+ # @return [Integer]
3554
+ def format_range(doDraw, startPos, endPos, draw, target, renderRect, pageRect) end
3555
+
3556
+ # Set printing to line wrapped ({Wx::STC::STC_WRAP_WORD}) or not line wrapped ({Wx::STC::STC_WRAP_NONE}).
3557
+ # @param wrapMode [Integer]
3558
+ # @return [void]
3559
+ def set_print_wrap_mode(wrapMode) end
3560
+ alias_method :print_wrap_mode=, :set_print_wrap_mode
3561
+
3562
+ # Is printing line wrapped?
3563
+ #
3564
+ # The return value will be one of the wxSTC_WRAP_* constants.
3565
+ # @return [Integer]
3566
+ def get_print_wrap_mode; end
3567
+ alias_method :print_wrap_mode, :get_print_wrap_mode
3568
+
3569
+ # Return a position which, to avoid performance costs, should not be within the range of a call to GetRangePointer.
3570
+ # @return [Integer]
3571
+ def get_gap_position; end
3572
+ alias_method :gap_position, :get_gap_position
3573
+
3574
+ # Find the display line of a document line taking hidden lines into account.
3575
+ # @param docLine [Integer]
3576
+ # @return [Integer]
3577
+ def visible_from_doc_line(docLine) end
3578
+
3579
+ # Find the document line of a display line taking hidden lines into account.
3580
+ # @param displayLine [Integer]
3581
+ # @return [Integer]
3582
+ def doc_line_from_visible(displayLine) end
3583
+
3584
+ # Set the fold level of a line.
3585
+ #
3586
+ # This encodes an integer level along with flags indicating whether the line is a header and whether it is effectively white space.
3587
+ # @param line [Integer]
3588
+ # @param level [Integer]
3589
+ # @return [void]
3590
+ def set_fold_level(line, level) end
3591
+
3592
+ # Retrieve the fold level of a line.
3593
+ # @param line [Integer]
3594
+ # @return [Integer]
3595
+ def get_fold_level(line) end
3596
+ alias_method :fold_level, :get_fold_level
3597
+
3598
+ # Find the last child line of a header line.
3599
+ # @param line [Integer]
3600
+ # @param level [Integer]
3601
+ # @return [Integer]
3602
+ def get_last_child(line, level) end
3603
+ alias_method :last_child, :get_last_child
3604
+
3605
+ # Find the parent line of a child line.
3606
+ # @param line [Integer]
3607
+ # @return [Integer]
3608
+ def get_fold_parent(line) end
3609
+ alias_method :fold_parent, :get_fold_parent
3610
+
3611
+ # Make a range of lines visible.
3612
+ # @param lineStart [Integer]
3613
+ # @param lineEnd [Integer]
3614
+ # @return [void]
3615
+ def show_lines(lineStart, lineEnd) end
3616
+
3617
+ # Make a range of lines invisible.
3618
+ # @param lineStart [Integer]
3619
+ # @param lineEnd [Integer]
3620
+ # @return [void]
3621
+ def hide_lines(lineStart, lineEnd) end
3622
+
3623
+ # Is a line visible?
3624
+ # @param line [Integer]
3625
+ # @return [Boolean]
3626
+ def get_line_visible(line) end
3627
+ alias_method :line_visible, :get_line_visible
3628
+
3629
+ # Are all lines visible?
3630
+ # @return [Boolean]
3631
+ def get_all_lines_visible; end
3632
+ alias_method :all_lines_visible, :get_all_lines_visible
3633
+
3634
+ # Show the children of a header line.
3635
+ # @param line [Integer]
3636
+ # @param expanded [Boolean]
3637
+ # @return [void]
3638
+ def set_fold_expanded(line, expanded) end
3639
+
3640
+ # Is a header line expanded?
3641
+ # @param line [Integer]
3642
+ # @return [Boolean]
3643
+ def get_fold_expanded(line) end
3644
+ alias_method :fold_expanded, :get_fold_expanded
3645
+
3646
+ # Switch a header line between expanded and contracted.
3647
+ # @param line [Integer]
3648
+ # @return [void]
3649
+ def toggle_fold(line) end
3650
+
3651
+ # Switch a header line between expanded and contracted and show some text after the line.
3652
+ # @param line [Integer]
3653
+ # @param text [String]
3654
+ # @return [void]
3655
+ def toggle_fold_show_text(line, text) end
3656
+
3657
+ # Set the style of fold display text.
3658
+ #
3659
+ # The input should be one of the wxSTC_FOLDDISPLAYTEXT_* constants.
3660
+ # @param style [Integer]
3661
+ # @return [void]
3662
+ def fold_display_text_set_style(style) end
3663
+
3664
+ # Expand or contract a fold header.
3665
+ #
3666
+ # The second argument should be one of the wxSTC_FOLDACTION_* constants.
3667
+ # @param line [Integer]
3668
+ # @param action [Integer]
3669
+ # @return [void]
3670
+ def fold_line(line, action) end
3671
+
3672
+ # Expand or contract a fold header and its children.
3673
+ #
3674
+ # The second argument should be one of the wxSTC_FOLDACTION_* constants.
3675
+ # @param line [Integer]
3676
+ # @param action [Integer]
3677
+ # @return [void]
3678
+ def fold_children(line, action) end
3679
+
3680
+ # Expand a fold header and all children.
3681
+ #
3682
+ # Use the level argument instead of the line's current level.
3683
+ # @param line [Integer]
3684
+ # @param level [Integer]
3685
+ # @return [void]
3686
+ def expand_children(line, level) end
3687
+
3688
+ # Expand or contract all fold headers.
3689
+ #
3690
+ # The input should be one of the wxSTC_FOLDACTION_* constants.
3691
+ # @param action [Integer]
3692
+ # @return [void]
3693
+ def fold_all(action) end
3694
+
3695
+ # Ensure a particular line is visible by expanding any header line hiding it.
3696
+ # @param line [Integer]
3697
+ # @return [void]
3698
+ def ensure_visible(line) end
3699
+
3700
+ # Set automatic folding behaviours.
3701
+ #
3702
+ # The input should be a bit list containing one or more of the wxSTC_AUTOMATICFOLD_* constants.
3703
+ # @param automaticFold [Integer]
3704
+ # @return [void]
3705
+ def set_automatic_fold(automaticFold) end
3706
+ alias_method :automatic_fold=, :set_automatic_fold
3707
+
3708
+ # Get automatic folding behaviours.
3709
+ #
3710
+ # The return value will be a bit list containing one or more of the wxSTC_AUTOMATICFOLD_* constants.
3711
+ # @return [Integer]
3712
+ def get_automatic_fold; end
3713
+ alias_method :automatic_fold, :get_automatic_fold
3714
+
3715
+ # Set some style options for folding.
3716
+ #
3717
+ # The second argument should be a bit list containing one or more of the wxSTC_FOLDFLAG_* constants.
3718
+ # @param flags [Integer]
3719
+ # @return [void]
3720
+ def set_fold_flags(flags) end
3721
+ alias_method :fold_flags=, :set_fold_flags
3722
+
3723
+ # Ensure a particular line is visible by expanding any header line hiding it.
3724
+ #
3725
+ # Use the currently set visibility policy to determine which range to display.
3726
+ # @param line [Integer]
3727
+ # @return [void]
3728
+ def ensure_visible_enforce_policy(line) end
3729
+
3730
+ # Find the next line at or after lineStart that is a contracted fold header line.
3731
+ #
3732
+ # Return -1 when no more lines.
3733
+ # @param lineStart [Integer]
3734
+ # @return [Integer]
3735
+ def contracted_fold_next(lineStart) end
3736
+
3737
+ # The number of display lines needed to wrap a document line.
3738
+ # @param docLine [Integer]
3739
+ # @return [Integer]
3740
+ def wrap_count(docLine) end
3741
+
3742
+ # Sets whether text is word wrapped.
3743
+ #
3744
+ # The input should be one of the wxSTC_WRAP_* constants.
3745
+ # @param wrapMode [Integer]
3746
+ # @return [void]
3747
+ def set_wrap_mode(wrapMode) end
3748
+ alias_method :wrap_mode=, :set_wrap_mode
3749
+
3750
+ # Retrieve whether text is word wrapped.
3751
+ #
3752
+ # The return value will be one of the wxSTC_WRAP_* constants.
3753
+ # @return [Integer]
3754
+ def get_wrap_mode; end
3755
+ alias_method :wrap_mode, :get_wrap_mode
3756
+
3757
+ # Set the display mode of visual flags for wrapped lines.
3758
+ #
3759
+ # The input should be a bit list containing one or more of the wxSTC_WRAPVISUALFLAG_* constants.
3760
+ # @param wrapVisualFlags [Integer]
3761
+ # @return [void]
3762
+ def set_wrap_visual_flags(wrapVisualFlags) end
3763
+ alias_method :wrap_visual_flags=, :set_wrap_visual_flags
3764
+
3765
+ # Retrieve the display mode of visual flags for wrapped lines.
3766
+ #
3767
+ # The return value will be a bit list containing one or more of the wxSTC_WRAPVISUALFLAG_* constants.
3768
+ # @return [Integer]
3769
+ def get_wrap_visual_flags; end
3770
+ alias_method :wrap_visual_flags, :get_wrap_visual_flags
3771
+
3772
+ # Set the location of visual flags for wrapped lines.
3773
+ #
3774
+ # The input should be a bit list containing one or more of the wxSTC_WRAPVISUALFLAGLOC_* constants.
3775
+ # @param wrapVisualFlagsLocation [Integer]
3776
+ # @return [void]
3777
+ def set_wrap_visual_flags_location(wrapVisualFlagsLocation) end
3778
+ alias_method :wrap_visual_flags_location=, :set_wrap_visual_flags_location
3779
+
3780
+ # Retrieve the location of visual flags for wrapped lines.
3781
+ #
3782
+ # The return value will be a bit list containing one or more of the wxSTC_WRAPVISUALFLAGLOC_* constants.
3783
+ # @return [Integer]
3784
+ def get_wrap_visual_flags_location; end
3785
+ alias_method :wrap_visual_flags_location, :get_wrap_visual_flags_location
3786
+
3787
+ # Set the start indent for wrapped lines.
3788
+ # @param indent [Integer]
3789
+ # @return [void]
3790
+ def set_wrap_start_indent(indent) end
3791
+ alias_method :wrap_start_indent=, :set_wrap_start_indent
3792
+
3793
+ # Retrieve the start indent for wrapped lines.
3794
+ # @return [Integer]
3795
+ def get_wrap_start_indent; end
3796
+ alias_method :wrap_start_indent, :get_wrap_start_indent
3797
+
3798
+ # Sets how wrapped sublines are placed.
3799
+ #
3800
+ # Default is {Wx::STC::STC_WRAPINDENT_FIXED}.
3801
+ # The input should be one of the wxSTC_WRAPINDENT_* constants.
3802
+ # @param wrapIndentMode [Integer]
3803
+ # @return [void]
3804
+ def set_wrap_indent_mode(wrapIndentMode) end
3805
+ alias_method :wrap_indent_mode=, :set_wrap_indent_mode
3806
+
3807
+ # Retrieve how wrapped sublines are placed.
3808
+ #
3809
+ # Default is {Wx::STC::STC_WRAPINDENT_FIXED}.
3810
+ # The return value will be one of the wxSTC_WRAPINDENT_* constants.
3811
+ # @return [Integer]
3812
+ def get_wrap_indent_mode; end
3813
+ alias_method :wrap_indent_mode, :get_wrap_indent_mode
3814
+
3815
+ # Retrieve the degree of caching of layout information.
3816
+ #
3817
+ # The return value will be one of the wxSTC_CACHE_* constants.
3818
+ # @return [Integer]
3819
+ def get_layout_cache; end
3820
+ alias_method :layout_cache, :get_layout_cache
3821
+
3822
+ # Join the lines in the target.
3823
+ # @return [void]
3824
+ def lines_join; end
3825
+
3826
+ # Split the lines in the target into lines that are less wide than pixelWidth where possible.
3827
+ # @param pixelWidth [Integer]
3828
+ # @return [void]
3829
+ def lines_split(pixelWidth) end
3830
+
3831
+ # Set number of entries in position cache.
3832
+ # @param size [Integer]
3833
+ # @return [void]
3834
+ def set_position_cache_size(size) end
3835
+ alias_method :position_cache_size=, :set_position_cache_size
3836
+
3837
+ # How many entries are allocated to the position cache?
3838
+ # @return [Integer]
3839
+ def get_position_cache_size; end
3840
+ alias_method :position_cache_size, :get_position_cache_size
3841
+
3842
+ # Magnify the displayed text by increasing the sizes by 1 point.
3843
+ # @return [void]
3844
+ def zoom_in; end
3845
+
3846
+ # Make the displayed text smaller by decreasing the sizes by 1 point.
3847
+ # @return [void]
3848
+ def zoom_out; end
3849
+
3850
+ # Set the zoom level.
3851
+ #
3852
+ # This number of points is added to the size of all fonts. It may be positive to magnify or negative to reduce.
3853
+ # @param zoomInPoints [Integer]
3854
+ # @return [void]
3855
+ def set_zoom(zoomInPoints) end
3856
+ alias_method :zoom=, :set_zoom
3857
+
3858
+ # Retrieve the zoom level.
3859
+ # @return [Integer]
3860
+ def get_zoom; end
3861
+ alias_method :zoom, :get_zoom
3862
+
3863
+ # Retrieve the column number which text should be kept within.
3864
+ # @return [Integer]
3865
+ def get_edge_column; end
3866
+ alias_method :edge_column, :get_edge_column
3867
+
3868
+ # Set the column number of the edge.
3869
+ #
3870
+ # If text goes past the edge then it is highlighted.
3871
+ # @param column [Integer]
3872
+ # @return [void]
3873
+ def set_edge_column(column) end
3874
+ alias_method :edge_column=, :set_edge_column
3875
+
3876
+ # Retrieve the edge highlight mode.
3877
+ #
3878
+ # The return value will be one of the wxSTC_EDGE_* constants.
3879
+ # @return [Integer]
3880
+ def get_edge_mode; end
3881
+ alias_method :edge_mode, :get_edge_mode
3882
+
3883
+ # The edge may be displayed by a line ({Wx::STC::STC_EDGE_LINE}/{Wx::STC::STC_EDGE_MULTILINE}) or by highlighting text that goes beyond it ({Wx::STC::STC_EDGE_BACKGROUND}) or not displayed at all ({Wx::STC::STC_EDGE_NONE}).
3884
+ #
3885
+ # The input should be one of the wxSTC_EDGE_* constants.
3886
+ # @param edgeMode [Integer]
3887
+ # @return [void]
3888
+ def set_edge_mode(edgeMode) end
3889
+ alias_method :edge_mode=, :set_edge_mode
3890
+
3891
+ # Retrieve the colour used in edge indication.
3892
+ # @return [Wx::Colour]
3893
+ def get_edge_colour; end
3894
+ alias_method :edge_colour, :get_edge_colour
3895
+
3896
+ # Change the colour used in edge indication.
3897
+ # @param edgeColour [Wx::Colour,String,Symbol]
3898
+ # @return [void]
3899
+ def set_edge_colour(edgeColour) end
3900
+ alias_method :edge_colour=, :set_edge_colour
3901
+
3902
+ # Add a new vertical edge to the view.
3903
+ # @param column [Integer]
3904
+ # @param edgeColour [Wx::Colour,String,Symbol]
3905
+ # @return [void]
3906
+ def multi_edge_add_line(column, edgeColour) end
3907
+
3908
+ # Clear all vertical edges.
3909
+ # @return [void]
3910
+ def multi_edge_clear_all; end
3911
+
3912
+ # Indicate that the internal state of a lexer has changed over a range and therefore there may be a need to redraw.
3913
+ # @param start [Integer]
3914
+ # @param end_ [Integer]
3915
+ # @return [Integer]
3916
+ def change_lexer_state(start, end_) end
3917
+
3918
+ # Set the lexing language of the document.
3919
+ #
3920
+ # The input should be one of the wxSTC_LEX_* constants.
3921
+ # @param lexer [Integer]
3922
+ # @return [void]
3923
+ def set_lexer(lexer) end
3924
+ alias_method :lexer=, :set_lexer
3925
+
3926
+ # Retrieve the lexing language of the document.
3927
+ #
3928
+ # The return value will be one of the wxSTC_LEX_* constants.
3929
+ # @return [Integer]
3930
+ def get_lexer; end
3931
+ alias_method :lexer, :get_lexer
3932
+
3933
+ # Colourise a segment of the document using the current lexing language.
3934
+ # @param start [Integer]
3935
+ # @param end_ [Integer]
3936
+ # @return [void]
3937
+ def colourise(start, end_) end
3938
+
3939
+ # Set up a value that may be used by a lexer for some optional feature.
3940
+ # @param key [String]
3941
+ # @param value [String]
3942
+ # @return [void]
3943
+ def set_property(key, value) end
3944
+
3945
+ # Set up the key words used by the lexer.
3946
+ # @param keyWordSet [Integer]
3947
+ # @param keyWords [String]
3948
+ # @return [void]
3949
+ def set_key_words(keyWordSet, keyWords) end
3950
+
3951
+ # Set the lexing language of the document based on string name.
3952
+ # @param language [String]
3953
+ # @return [void]
3954
+ def set_lexer_language(language) end
3955
+ alias_method :lexer_language=, :set_lexer_language
3956
+
3957
+ # Load a lexer library (dll / so).
3958
+ # @param path [String]
3959
+ # @return [void]
3960
+ def load_lexer_library(path) end
3961
+
3962
+ # Retrieve a "property" value previously set with SetProperty.
3963
+ # @param key [String]
3964
+ # @return [String]
3965
+ def get_property(key) end
3966
+ alias_method :property, :get_property
3967
+
3968
+ # Retrieve a "property" value previously set with SetProperty, with "$()" variable replacement on returned buffer.
3969
+ # @param key [String]
3970
+ # @return [String]
3971
+ def get_property_expanded(key) end
3972
+ alias_method :property_expanded, :get_property_expanded
3973
+
3974
+ # Retrieve a "property" value previously set with SetProperty, interpreted as an int AFTER any "$()" variable replacement.
3975
+ # @param key [String]
3976
+ # @param defaultValue [Integer]
3977
+ # @return [Integer]
3978
+ def get_property_int(key, defaultValue=0) end
3979
+ alias_method :property_int, :get_property_int
3980
+
3981
+ # Retrieve the lexing language of the document.
3982
+ # @return [String]
3983
+ def get_lexer_language; end
3984
+ alias_method :lexer_language, :get_lexer_language
3985
+
3986
+ # Retrieve a '\n' separated list of properties understood by the current lexer.
3987
+ # @return [String]
3988
+ def property_names; end
3989
+
3990
+ # Retrieve the type of a property.
3991
+ #
3992
+ # The return value will be one of the wxSTC_TYPE_* constants.
3993
+ # @param name [String]
3994
+ # @return [Integer]
3995
+ def property_type(name) end
3996
+
3997
+ # Describe a property.
3998
+ # @param name [String]
3999
+ # @return [String]
4000
+ def describe_property(name) end
4001
+
4002
+ # Retrieve a '\n' separated list of descriptions of the keyword sets understood by the current lexer.
4003
+ # @return [String]
4004
+ def describe_key_word_sets; end
4005
+
4006
+ # Allocate a set of sub styles for a particular base style, returning start of range.
4007
+ # @param styleBase [Integer]
4008
+ # @param numberStyles [Integer]
4009
+ # @return [Integer]
4010
+ def allocate_sub_styles(styleBase, numberStyles) end
4011
+
4012
+ # The starting style number for the sub styles associated with a base style.
4013
+ # @param styleBase [Integer]
4014
+ # @return [Integer]
4015
+ def get_sub_styles_start(styleBase) end
4016
+ alias_method :sub_styles_start, :get_sub_styles_start
4017
+
4018
+ # The number of sub styles associated with a base style.
4019
+ # @param styleBase [Integer]
4020
+ # @return [Integer]
4021
+ def get_sub_styles_length(styleBase) end
4022
+ alias_method :sub_styles_length, :get_sub_styles_length
4023
+
4024
+ # For a sub style, return the base style, else return the argument.
4025
+ # @param subStyle [Integer]
4026
+ # @return [Integer]
4027
+ def get_style_from_sub_style(subStyle) end
4028
+ alias_method :style_from_sub_style, :get_style_from_sub_style
4029
+
4030
+ # For a secondary style, return the primary style, else return the argument.
4031
+ # @param style [Integer]
4032
+ # @return [Integer]
4033
+ def get_primary_style_from_style(style) end
4034
+ alias_method :primary_style_from_style, :get_primary_style_from_style
4035
+
4036
+ # Free allocated sub styles.
4037
+ # @return [void]
4038
+ def free_sub_styles; end
4039
+
4040
+ # Set the identifiers that are shown in a particular style.
4041
+ # @param style [Integer]
4042
+ # @param identifiers [String]
4043
+ # @return [void]
4044
+ def set_identifiers(style, identifiers) end
4045
+
4046
+ # Where styles are duplicated by a feature such as active/inactive code return the distance between the two types.
4047
+ # @return [Integer]
4048
+ def distance_to_secondary_styles; end
4049
+
4050
+ # Get the set of base styles that can be extended with sub styles.
4051
+ # @return [String]
4052
+ def get_sub_style_bases; end
4053
+ alias_method :sub_style_bases, :get_sub_style_bases
4054
+
4055
+ # Sets the time the mouse must sit still to generate a mouse dwell event.
4056
+ #
4057
+ # The input should be a time in milliseconds or {Wx::STC::STC_TIME_FOREVER}.
4058
+ # @param periodMilliseconds [Integer]
4059
+ # @return [void]
4060
+ def set_mouse_dwell_time(periodMilliseconds) end
4061
+ alias_method :mouse_dwell_time=, :set_mouse_dwell_time
4062
+
4063
+ # Retrieve the time the mouse must sit still to generate a mouse dwell event.
4064
+ #
4065
+ # The return value will be a time in milliseconds or {Wx::STC::STC_TIME_FOREVER}.
4066
+ # @return [Integer]
4067
+ def get_mouse_dwell_time; end
4068
+ alias_method :mouse_dwell_time, :get_mouse_dwell_time
4069
+
4070
+ # Set which document modification events are sent to the container.
4071
+ #
4072
+ # The input should be a bit list containing one or more of the wxSTC_MOD_* constants, the wxSTC_PERFORMED_* constants, {Wx::STC::STC_STARTACTION}, {Wx::STC::STC_MULTILINEUNDOREDO}, {Wx::STC::STC_MULTISTEPUNDOREDO}, and {Wx::STC::STC_LASTSTEPINUNDOREDO}. The input can also be {Wx::STC::STC_MODEVENTMASKALL} to indicate that all changes should generate events.
4073
+ # @param eventMask [Integer]
4074
+ # @return [void]
4075
+ def set_mod_event_mask(eventMask) end
4076
+ alias_method :mod_event_mask=, :set_mod_event_mask
4077
+
4078
+ # Get which document modification events are sent to the container.
4079
+ #
4080
+ # The return value will {Wx::STC::STC_MODEVENTMASKALL} if all changes generate events. Otherwise it will be a bit list containing one or more of the wxSTC_MOD_* constants, the wxSTC_PERFORMED_* constants, {Wx::STC::STC_STARTACTION}, {Wx::STC::STC_MULTILINEUNDOREDO}, {Wx::STC::STC_MULTISTEPUNDOREDO}, and {Wx::STC::STC_LASTSTEPINUNDOREDO}.
4081
+ # @return [Integer]
4082
+ def get_mod_event_mask; end
4083
+ alias_method :mod_event_mask, :get_mod_event_mask
4084
+
4085
+ # Set the identifier reported as idFrom in notification messages.
4086
+ # @param identifier [Integer]
4087
+ # @return [void]
4088
+ def set_identifier(identifier) end
4089
+ alias_method :identifier=, :set_identifier
4090
+
4091
+ # Get the identifier.
4092
+ # @return [Integer]
4093
+ def get_identifier; end
4094
+ alias_method :identifier, :get_identifier
4095
+
4096
+ # Returns the line number of the line with the caret.
4097
+ # @return [Integer]
4098
+ def get_current_line; end
4099
+ alias_method :current_line, :get_current_line
4100
+
4101
+ # Returns the total number of display lines.
4102
+ #
4103
+ # This may be different from the value returned by {Wx::STC::StyledTextCtrl#get_line_count} because of folding and wrapping.
4104
+ # Note that this is not the same as GetVisibleLineCount() which returns the number of lines currently visible on screen.
4105
+ # @return [Integer]
4106
+ def get_display_line_count; end
4107
+ alias_method :display_line_count, :get_display_line_count
4108
+
4109
+ # Extract style settings from a spec-string which is composed of one or more of the following comma separated elements:
4110
+ #
4111
+ # bold turns on bold italic turns on italics fore:[name or \#RRGGBB] sets the foreground colour back:[name or \#RRGGBB] sets the background colour face:[facename] sets the font face name to use size:[num] sets the font size in points eol turns on eol filling underline turns on underlining
4112
+ # @param styleNum [Integer]
4113
+ # @param spec [String]
4114
+ # @return [void]
4115
+ def style_set_spec(styleNum, spec) end
4116
+
4117
+ # Get the font of a style.
4118
+ # @param style [Integer]
4119
+ # @return [Wx::Font]
4120
+ def style_get_font(style) end
4121
+
4122
+ # Set style size, face, bold, italic, and underline attributes from a {Wx::Font}'s attributes.
4123
+ # @param styleNum [Integer]
4124
+ # @param font [Wx::Font]
4125
+ # @return [void]
4126
+ def style_set_font(styleNum, font) end
4127
+
4128
+ # Set all font style attributes at once.
4129
+ # @param styleNum [Integer]
4130
+ # @param size [Integer]
4131
+ # @param faceName [String]
4132
+ # @param bold [Boolean]
4133
+ # @param italic [Boolean]
4134
+ # @param underline [Boolean]
4135
+ # @param encoding [Wx::FontEncoding]
4136
+ # @return [void]
4137
+ def style_set_font_attr(styleNum, size, faceName, bold, italic, underline, encoding=Wx::FontEncoding::FONTENCODING_DEFAULT) end
4138
+
4139
+ # Set the font encoding to be used by a style.
4140
+ # @param style [Integer]
4141
+ # @param encoding [Wx::FontEncoding]
4142
+ # @return [void]
4143
+ def style_set_font_encoding(style, encoding) end
4144
+
4145
+ # Perform one of the operations defined by the {Wx::STC_CMD_}* constants.
4146
+ # @param cmd [Integer]
4147
+ # @return [void]
4148
+ def cmd_key_execute(cmd) end
4149
+
4150
+ # Set the left and right margin in the edit area, measured in pixels.
4151
+ # @param left [Integer]
4152
+ # @param right [Integer]
4153
+ # @return [void]
4154
+ def set_margins(left, right) end
4155
+
4156
+ # Scroll enough to make the given line visible.
4157
+ # @param line [Integer]
4158
+ # @return [void]
4159
+ def scroll_to_line(line) end
4160
+
4161
+ # Scroll enough to make the given column visible.
4162
+ # @param column [Integer]
4163
+ # @return [void]
4164
+ def scroll_to_column(column) end
4165
+
4166
+ # Scintilla API call.
4167
+ # @param msg [Integer]
4168
+ # @param wp [Integer]
4169
+ # @param lp [Integer]
4170
+ # @return [Integer]
4171
+ def send_msg(msg, wp=0, lp=0) end
4172
+
4173
+ # Set the vertical scrollbar to use instead of the one that's built-in.
4174
+ # @param bar [Wx::ScrollBar]
4175
+ # @return [void]
4176
+ def set_v_scroll_bar(bar) end
4177
+ alias_method :v_scroll_bar=, :set_v_scroll_bar
4178
+
4179
+ # Set the horizontal scrollbar to use instead of the one that's built-in.
4180
+ # @param bar [Wx::ScrollBar]
4181
+ # @return [void]
4182
+ def set_h_scroll_bar(bar) end
4183
+ alias_method :h_scroll_bar=, :set_h_scroll_bar
4184
+
4185
+ # Can be used to prevent the EVT_CHAR handler from adding the char.
4186
+ # @return [Boolean]
4187
+ def get_last_keydown_processed; end
4188
+ alias_method :last_keydown_processed, :get_last_keydown_processed
4189
+
4190
+ # Returns the line number of the line with the caret.
4191
+ # @param val [Boolean]
4192
+ # @return [void]
4193
+ def set_last_keydown_processed(val) end
4194
+ alias_method :last_keydown_processed=, :set_last_keydown_processed
4195
+
4196
+ # Write the contents of the editor to filename.
4197
+ # @param filename [String]
4198
+ # @return [Boolean]
4199
+ def save_file(filename) end
4200
+
4201
+ # Load the contents of filename into the editor.
4202
+ # @param filename [String]
4203
+ # @return [Boolean]
4204
+ def load_file(filename) end
4205
+
4206
+ # Allow for simulating a DnD DragEnter.
4207
+ # @param x [Integer]
4208
+ # @param y [Integer]
4209
+ # @param defaultRes [Wx::DragResult]
4210
+ # @return [Wx::DragResult]
4211
+ def do_drag_enter(x, y, defaultRes) end
4212
+
4213
+ # Allow for simulating a DnD DragOver.
4214
+ # @param x [Integer]
4215
+ # @param y [Integer]
4216
+ # @param defaultRes [Wx::DragResult]
4217
+ # @return [Wx::DragResult]
4218
+ def do_drag_over(x, y, defaultRes) end
4219
+
4220
+ # Allow for simulating a DnD DragLeave.
4221
+ # @return [void]
4222
+ def do_drag_leave; end
4223
+
4224
+ # Allow for simulating a DnD DropText.
4225
+ # @param x [Integer]
4226
+ # @param y [Integer]
4227
+ # @param data [String]
4228
+ # @return [Boolean]
4229
+ def do_drop_text(x, y, data) end
4230
+
4231
+ # Specify whether anti-aliased fonts should be used.
4232
+ #
4233
+ # This will have no effect on some platforms, but on some (WXOSX for example) can greatly improve performance.
4234
+ # @param useAA [Boolean]
4235
+ # @return [void]
4236
+ def set_use_anti_aliasing(useAA) end
4237
+ alias_method :use_anti_aliasing=, :set_use_anti_aliasing
4238
+
4239
+ # Returns the current UseAntiAliasing setting.
4240
+ # @return [Boolean]
4241
+ def get_use_anti_aliasing; end
4242
+ alias_method :use_anti_aliasing, :get_use_anti_aliasing
4243
+
4244
+ # Clear annotations from the given line.
4245
+ # @param line [Integer]
4246
+ # @return [void]
4247
+ def annotation_clear_line(line) end
4248
+
4249
+ # Define a marker with a {Wx::Bitmap}.
4250
+ # @param markerNumber [Integer]
4251
+ # @param bmp [Wx::Bitmap]
4252
+ # @return [void]
4253
+ def marker_define_bitmap(markerNumber, bmp) end
4254
+
4255
+ # Writes the text into the text control at the current insertion position.
4256
+ #
4257
+ # <div class="wxrb-remark">
4258
+ # <b>Remark:</b>
4259
+ # <p>Newlines in the text string are the only control characters allowed, and they will cause appropriate line breaks. See {Wx::operator<<()} and {Wx::STC::StyledTextCtrl#append_text} for more convenient ways of writing to the window. After the write operation, the insertion point will be at the end of the inserted text, so subsequent write operations will be appended. To append text after the user may have interacted with the control, call {Wx::TextCtrl#set_insertion_point_end} before writing.
4260
+ # </p>
4261
+ # </div>
4262
+ # @param text [String] Text to write to the text control.
4263
+ # @return [void]
4264
+ def write_text(text) end
4265
+
4266
+ # Removes the text starting at the first given position up to (but not including) the character at the last position.
4267
+ #
4268
+ # This function puts the current insertion point position at to as a side effect.
4269
+ # @param from [Integer] The first position.
4270
+ # @param to [Integer] The last position.
4271
+ # @return [void]
4272
+ def remove(from, to) end
4273
+
4274
+ # Replaces the text starting at the first position up to (but not including) the character at the last position with the given text.
4275
+ #
4276
+ # This function puts the current insertion point position at to as a side effect.
4277
+ # @param from [Integer] The first position.
4278
+ # @param to [Integer] The last position.
4279
+ # @param value [String] The value to replace the existing text with.
4280
+ # @return [void]
4281
+ def replace(from, to, value) end
4282
+
4283
+ # Sets the insertion point at the given position.
4284
+ # @param pos [Integer] Position to set, in the range from 0 to {Wx::STC::StyledTextCtrl#get_last_position} inclusive.
4285
+ # @return [void]
4286
+ def set_insertion_point(pos) end
4287
+ alias_method :insertion_point=, :set_insertion_point
4288
+
4289
+ # Returns the insertion point, or cursor, position.
4290
+ #
4291
+ # This is defined as the zero based index of the character position to the right of the insertion point. For example, if the insertion point is at the end of the single-line text control, it is equal to {Wx::STC::StyledTextCtrl#get_last_position}.
4292
+ # 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.
4293
+ # 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:
4294
+ #
4295
+ # ```ruby
4296
+ # def get_current_char(tc)
4297
+ # pos = tc.insertion_point
4298
+ # if pos == tc.last_position
4299
+ # nil
4300
+ # else
4301
+ # tc.get_range(pos, pos + 1)
4302
+ # end
4303
+ # end
4304
+ # ```
4305
+ # @return [Integer]
4306
+ def get_insertion_point; end
4307
+ alias_method :insertion_point, :get_insertion_point
4308
+
4309
+ # Returns the zero based index of the last position in the text control, which is equal to the number of characters in the control.
4310
+ # @return [Integer]
4311
+ def get_last_position; end
4312
+ alias_method :last_position, :get_last_position
4313
+
4314
+ # Selects the text starting at the first position up to (but not including) the character at the last position.
4315
+ #
4316
+ # If both parameters are equal to -1 all text in the control is selected.
4317
+ # Notice that the insertion point will be moved to from by this function.
4318
+ # @see Wx::STC::StyledTextCtrl#select_all
4319
+ # @param from [Integer] The first position.
4320
+ # @param to [Integer] The last position.
4321
+ # @return [void]
4322
+ def set_selection(from, to) end
4323
+
4324
+ # Deselects selected text in the control.
4325
+ # @return [void]
4326
+ def select_none; end
4327
+
4328
+ # Gets the current selection span.
4329
+ #
4330
+ # 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.
4331
+ # @return [Array(Integer, Integer)]
4332
+ def get_selection; end
4333
+ alias_method :selection, :get_selection
4334
+
4335
+ # Returns true if the controls contents may be edited by user (note that it always can be changed by the program).
4336
+ #
4337
+ # In other words, this functions returns true if the control hasn't been put in read-only mode by a previous call to {Wx::STC::StyledTextCtrl#set_editable}.
4338
+ # @return [Boolean]
4339
+ def is_editable; end
4340
+ alias_method :editable?, :is_editable
4341
+
4342
+ # Makes the text item editable or read-only, overriding the <b>{Wx::TE_READONLY}</b> flag.
4343
+ #
4344
+ #
4345
+ # @see Wx::STC::StyledTextCtrl#is_editable
4346
+ # @param editable [Boolean] If true, the control is editable. If false, the control is read-only.
4347
+ # @return [void]
4348
+ def set_editable(editable) end
4349
+ alias_method :editable=, :set_editable
4350
+
4351
+ # Gets the length of the specified line, not including any trailing newline character(s).
4352
+ #
4353
+ # The length of the line, or -1 if lineNo was invalid.
4354
+ # @param lineNo [Integer] Line number (starting from zero).
4355
+ # @return [Integer]
4356
+ def get_line_length(lineNo) end
4357
+
4358
+ # Returns the contents of a given line in the text control, not including any trailing newline character(s).
4359
+ #
4360
+ # The contents of the line.
4361
+ # @param lineNo [Integer] The line number, starting from zero.
4362
+ # @return [String]
4363
+ def get_line_text(lineNo) end
4364
+ alias_method :line_text, :get_line_text
4365
+
4366
+ # Returns the number of lines in the text control buffer.
4367
+ #
4368
+ # The returned number is the number of logical lines, i.e. just the count of the number of newline characters in the control + 1, for WXGTK and WXOSX/Cocoa ports while it is the number of physical lines, i.e. the count of lines actually shown in the control, in WXMSW. Because of this discrepancy, it is not recommended to use this function.
4369
+ #
4370
+ # <div class="wxrb-remark">
4371
+ # <b>Remark:</b>
4372
+ # <p>Note that even empty text controls have one line (where the insertion point is), so {Wx::STC::StyledTextCtrl#get_number_of_lines} never returns 0.
4373
+ # </p>
4374
+ # </div>
4375
+ # @return [Integer]
4376
+ def get_number_of_lines; end
4377
+ alias_method :number_of_lines, :get_number_of_lines
4378
+
4379
+ # Returns true if the text has been modified by user.
4380
+ #
4381
+ # Note that calling {Wx::STC::StyledTextCtrl#set_value} doesn't make the control modified.
4382
+ # @see Wx::STC::StyledTextCtrl#mark_dirty
4383
+ # @return [Boolean]
4384
+ def is_modified; end
4385
+ alias_method :modified?, :is_modified
4386
+
4387
+ # Mark text as modified (dirty).
4388
+ #
4389
+ #
4390
+ # @see Wx::STC::StyledTextCtrl#is_modified
4391
+ # @return [void]
4392
+ def mark_dirty; end
4393
+
4394
+ # Resets the internal modified flag as if the current changes had been saved.
4395
+ # @return [void]
4396
+ def discard_edits; end
4397
+
4398
+ # This method is inherited from {Wx::TextAreaBase} but is not implemented in {Wx::STC::StyledTextCtrl}.
4399
+ # @param start [Integer]
4400
+ # @param end_ [Integer]
4401
+ # @param style [Wx::TextAttr]
4402
+ # @return [Boolean]
4403
+ def set_style(start, end_, style) end
4404
+
4405
+ # This method is inherited from {Wx::TextAreaBase} but is not implemented in {Wx::STC::StyledTextCtrl}.
4406
+ # @param position [Integer]
4407
+ # @param style [Wx::TextAttr]
4408
+ # @return [Boolean]
4409
+ def get_style(position, style) end
4410
+ alias_method :style, :get_style
4411
+
4412
+ # This method is inherited from {Wx::TextAreaBase} but is not implemented in {Wx::STC::StyledTextCtrl}.
4413
+ # @param style [Wx::TextAttr]
4414
+ # @return [Boolean]
4415
+ def set_default_style(style) end
4416
+ alias_method :default_style=, :set_default_style
4417
+
4418
+ # Converts the given zero based column and line number to a position.
4419
+ #
4420
+ # The position value, or -1 if x or y was invalid.
4421
+ # @param x [Integer] The column number.
4422
+ # @param y [Integer] The line number.
4423
+ # @return [Integer]
4424
+ def xy_to_position(x, y) end
4425
+
4426
+ # Converts given position to a zero-based column, line number pair.
4427
+ #
4428
+ # true on success, false on failure (most likely due to a too large position parameter).
4429
+ # @see Wx::STC::StyledTextCtrl#xy_to_position
4430
+ # @param pos [Integer] Position.
4431
+ # @return [Array(Boolean,Array(Integer, Integer))]
4432
+ def position_to_xy(pos) end
4433
+
4434
+ # Makes the line containing the given position visible.
4435
+ # @param pos [Integer] The position that should be visible.
4436
+ # @return [void]
4437
+ def show_position(pos) end
4438
+
4439
+ # Finds the row and column of the character at the specified point.
4440
+ #
4441
+ # 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.
4442
+ # Please note that this function is currently only implemented in {Wx::Univ}, WXMSW and WXGTK2 ports and always returns {Wx::TextCtrlHitTestResult::TE_HT_UNKNOWN} in the other ports.
4443
+ # @see Wx::STC::StyledTextCtrl#position_to_xy
4444
+ # @see Wx::STC::StyledTextCtrl#xy_to_position
4445
+ # @param pt [Array(Integer, Integer), Wx::Point] The position of the point to check, in window device coordinates.
4446
+ # @return [Array(Wx::TextCtrlHitTestResult,Array(Integer, Integer))]
4447
+ def hit_test(pt) end
4448
+
4449
+ # Specify a control to synchronize with this control.
4450
+ #
4451
+ # If mirrorCtrl is non-null, then various aspects of the text in this control will be reflected in it too. For example, whenever a fold is opened/closed in this control, a fold at the same line will be opened/closed in the mirror control as well. Similarly, any markers defined for the lines in this control will be also defined for the same line in the mirror control (but notice that markers defined before calling this function won't be synchronized when it is called). This will only be useful if both controls have the same text contents, i.e. if they share the same {Wx::STC::StyledTextCtrl#get_doc_pointer} which is e.g. the case of {Wx::StyledTextCtrlMiniMap}.
4452
+ # @param mirrorCtrl [Wx::STC::StyledTextCtrl] The control to synchronize with or nil to disable synchronization if it had been previously enabled.
4453
+ # @return [void]
4454
+ def set_mirror_ctrl(mirrorCtrl) end
4455
+ alias_method :mirror_ctrl=, :set_mirror_ctrl
4456
+
4457
+ # Indicate that custom drawing is done on top of this control.
4458
+ #
4459
+ # This is necessary to avoid corrupting it by scrolling the window content instead of refreshing it when it needs to be scrolled.
4460
+ # @param customDrawn [Boolean] If true, indicates that custom drawing is done on top of this control.
4461
+ # @return [void]
4462
+ def set_custom_drawn(customDrawn) end
4463
+ alias_method :custom_drawn=, :set_custom_drawn
4464
+
4465
+ # Returns the version of the Scintilla library used by this control.
4466
+ # @return [Wx::VersionInfo]
4467
+ def self.get_library_version_info; end
4468
+
4469
+ end # StyledTextCtrl
4470
+
4471
+
4472
+ end
4473
+
4474
+ end