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,2103 @@
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 RTC
10
+
11
+ #
12
+ RE_READONLY = 16
13
+
14
+ #
15
+ RE_MULTILINE = 32
16
+
17
+ #
18
+ RE_CENTRE_CARET = 32768
19
+
20
+ #
21
+ RE_CENTER_CARET = 32768
22
+
23
+ #
24
+ RICHTEXT_SHIFT_DOWN = 1
25
+
26
+ #
27
+ RICHTEXT_CTRL_DOWN = 2
28
+
29
+ #
30
+ RICHTEXT_ALT_DOWN = 4
31
+
32
+ #
33
+ RICHTEXT_EX_NO_GUIDELINES = 256
34
+
35
+ #
36
+ RICHTEXT_DEFAULT_OVERALL_SIZE = Wx::Size.new(-1, -1)
37
+
38
+ #
39
+ RICHTEXT_DEFAULT_IMAGE_SIZE = Wx::Size.new(80, 80)
40
+
41
+ #
42
+ RICHTEXT_DEFAULT_SPACING = 3
43
+
44
+ #
45
+ RICHTEXT_DEFAULT_MARGIN = 3
46
+
47
+ #
48
+ RICHTEXT_DEFAULT_UNFOCUSSED_BACKGROUND = Wx::Colour.new(175, 175, 175)
49
+
50
+ #
51
+ RICHTEXT_DEFAULT_FOCUSSED_BACKGROUND = Wx::Colour.new(140, 140, 140)
52
+
53
+ #
54
+ RICHTEXT_DEFAULT_UNSELECTED_BACKGROUND = Wx::SystemSettings.get_colour(Wx::SYS_COLOUR_3DFACE)
55
+
56
+ #
57
+ RICHTEXT_DEFAULT_TYPE_COLOUR = Wx::Colour.new(0, 0, 200)
58
+
59
+ #
60
+ RICHTEXT_DEFAULT_FOCUS_RECT_COLOUR = Wx::Colour.new(100, 80, 80)
61
+
62
+ #
63
+ RICHTEXT_DEFAULT_CARET_WIDTH = 2
64
+
65
+ #
66
+ RICHTEXT_DEFAULT_DELAYED_LAYOUT_THRESHOLD = 20000
67
+
68
+ #
69
+ RICHTEXT_DEFAULT_LAYOUT_INTERVAL = 50
70
+
71
+ #
72
+ RICHTEXT_DEFAULT_DELAYED_IMAGE_PROCESSING_INTERVAL = 200
73
+
74
+ #
75
+ ID_RICHTEXT_PROPERTIES1 = 6001
76
+
77
+ #
78
+ ID_RICHTEXT_PROPERTIES2 = 6002
79
+
80
+ #
81
+ ID_RICHTEXT_PROPERTIES3 = 6003
82
+
83
+ #
84
+ #
85
+ #
86
+ #
87
+ # @wxrb_require USE_RICHTEXT
88
+ class RichTextCtrlSelectionState < Wx::Enum
89
+
90
+ #
91
+ #
92
+ RichTextCtrlSelectionState_Normal = Wx::RTC::RichTextCtrlSelectionState.new(0)
93
+
94
+ #
95
+ #
96
+ RichTextCtrlSelectionState_CommonAncestor = Wx::RTC::RichTextCtrlSelectionState.new(1)
97
+
98
+ end # RichTextCtrlSelectionState
99
+
100
+ #
101
+ #
102
+ EVT_RICHTEXT_LEFT_CLICK = 10406
103
+
104
+ #
105
+ #
106
+ EVT_RICHTEXT_RIGHT_CLICK = 10408
107
+
108
+ #
109
+ #
110
+ EVT_RICHTEXT_MIDDLE_CLICK = 10407
111
+
112
+ #
113
+ #
114
+ EVT_RICHTEXT_LEFT_DCLICK = 10409
115
+
116
+ #
117
+ #
118
+ EVT_RICHTEXT_RETURN = 10410
119
+
120
+ #
121
+ #
122
+ EVT_RICHTEXT_CHARACTER = 10411
123
+
124
+ #
125
+ #
126
+ EVT_RICHTEXT_CONSUMING_CHARACTER = 10412
127
+
128
+ #
129
+ #
130
+ EVT_RICHTEXT_DELETE = 10413
131
+
132
+ #
133
+ #
134
+ EVT_RICHTEXT_STYLESHEET_CHANGING = 10416
135
+
136
+ #
137
+ #
138
+ EVT_RICHTEXT_STYLESHEET_CHANGED = 10417
139
+
140
+ #
141
+ #
142
+ EVT_RICHTEXT_STYLESHEET_REPLACING = 10414
143
+
144
+ #
145
+ #
146
+ EVT_RICHTEXT_STYLESHEET_REPLACED = 10415
147
+
148
+ #
149
+ #
150
+ EVT_RICHTEXT_CONTENT_INSERTED = 10418
151
+
152
+ #
153
+ #
154
+ EVT_RICHTEXT_CONTENT_DELETED = 10419
155
+
156
+ #
157
+ #
158
+ EVT_RICHTEXT_STYLE_CHANGED = 10420
159
+
160
+ #
161
+ #
162
+ EVT_RICHTEXT_PROPERTIES_CHANGED = 10421
163
+
164
+ #
165
+ #
166
+ EVT_RICHTEXT_SELECTION_CHANGED = 10422
167
+
168
+ #
169
+ #
170
+ EVT_RICHTEXT_BUFFER_RESET = 10423
171
+
172
+ #
173
+ #
174
+ EVT_RICHTEXT_FOCUS_OBJECT_CHANGED = 10424
175
+
176
+ # {Wx::RTC::RichTextCtrl} provides a generic, ground-up implementation of a text control capable of showing multiple styles and images.
177
+ #
178
+ # {Wx::RTC::RichTextCtrl} sends notification events: see {Wx::RTC::RichTextEvent}.
179
+ # It also sends the standard {Wx::TextCtrl} events {Wx::EVT_TEXT_ENTER} and {Wx::EVT_TEXT}, and {Wx::TextUrlEvent} when URL content is clicked.
180
+ # For more information, see the wxRichTextCtrl Overview.
181
+ # ### Styles
182
+ #
183
+ # This class supports the following styles:
184
+ #
185
+ # - {Wx::RTC::RE_CENTRE_CARET}: The control will try to keep the caret line centred vertically while editing. {Wx::RTC::RE_CENTER_CARET} is a synonym for this style.
186
+ #
187
+ # - {Wx::RTC::RE_MULTILINE}: The control will be multiline (mandatory).
188
+ #
189
+ # - {Wx::RTC::RE_READONLY}: The control will not be editable.
190
+ #
191
+ # Category: Rich Text <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
192
+ # </td><td> WXGTK Appearance
193
+ # </td><td> WXOSX Appearance
194
+ # </td></tr></table></div>
195
+ #
196
+ # @wxrb_require USE_RICHTEXT
197
+ class RichTextCtrl < Control
198
+
199
+ include Wx::TextEntry
200
+
201
+ # @overload initialize()
202
+ # Default constructor.
203
+ # @return [Wx::RTC::RichTextCtrl]
204
+ # @overload initialize(parent, id=-1, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::RTC::RE_MULTILINE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TEXT_CTRL_NAME_STR)
205
+ # Constructor, creating and showing a rich text control.
206
+ #
207
+ #
208
+ # @see Wx::RTC::RichTextCtrl#create
209
+ # @see Wx::Validator
210
+ # @param parent [Wx::Window] Parent window. Must not be nil.
211
+ # @param id [Integer] Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
212
+ # @param value [String] Default string.
213
+ # @param pos [Array(Integer, Integer), Wx::Point] Window position.
214
+ # @param size [Array(Integer, Integer), Wx::Size] Window size.
215
+ # @param style [Integer] Window style.
216
+ # @param validator [Wx::Validator] Window validator.
217
+ # @param name [String] Window name.
218
+ # @return [Wx::RTC::RichTextCtrl]
219
+ # @overload initialize(parent, id=-1, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::RTC::RE_MULTILINE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TEXT_CTRL_NAME_STR, &block)
220
+ # Constructor, creating and showing a rich text control.
221
+ #
222
+ #
223
+ # @see Wx::RTC::RichTextCtrl#create
224
+ # @see Wx::Validator
225
+ # @param parent [Wx::Window] Parent window. Must not be nil.
226
+ # @param id [Integer] Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
227
+ # @param value [String] Default string.
228
+ # @param pos [Array(Integer, Integer), Wx::Point] Window position.
229
+ # @param size [Array(Integer, Integer), Wx::Size] Window size.
230
+ # @param style [Integer] Window style.
231
+ # @param validator [Wx::Validator] Window validator.
232
+ # @param name [String] Window name.
233
+ # @yieldparam [Wx::RTC::RichTextCtrl] win new instance
234
+ # @return [Wx::RTC::RichTextCtrl]
235
+ def initialize(*args) end
236
+
237
+ # Creates the underlying window.
238
+ # @param parent [Wx::Window]
239
+ # @param id [Integer]
240
+ # @param value [String]
241
+ # @param pos [Array(Integer, Integer), Wx::Point]
242
+ # @param size [Array(Integer, Integer), Wx::Size]
243
+ # @param style [Integer]
244
+ # @param validator [Wx::Validator]
245
+ # @param name [String]
246
+ # @return [Boolean]
247
+ def create(parent, id=-1, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::RTC::RE_MULTILINE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TEXT_CTRL_NAME_STR) end
248
+
249
+ # Initialises the members of the control.
250
+ # @return [void]
251
+ def init; end
252
+
253
+ # Gets the text for the given range.
254
+ #
255
+ # The end point of range is specified as the last character position of the span of text, plus one.
256
+ # @param from [Integer]
257
+ # @param to [Integer]
258
+ # @return [String]
259
+ def get_range(from, to) end
260
+ alias_method :range, :get_range
261
+
262
+ # Returns the length of the specified line in characters.
263
+ # @param lineNo [Integer]
264
+ # @return [Integer]
265
+ def get_line_length(lineNo) end
266
+ alias_method :line_length, :get_line_length
267
+
268
+ # Returns the text for the given line.
269
+ # @param lineNo [Integer]
270
+ # @return [String]
271
+ def get_line_text(lineNo) end
272
+ alias_method :line_text, :get_line_text
273
+
274
+ # Returns the number of lines in the buffer.
275
+ # @return [Integer]
276
+ def get_number_of_lines; end
277
+ alias_method :number_of_lines, :get_number_of_lines
278
+
279
+ # Returns true if the buffer has been modified.
280
+ # @return [Boolean]
281
+ def is_modified; end
282
+ alias_method :modified?, :is_modified
283
+
284
+ # Returns true if the control is editable.
285
+ # @return [Boolean]
286
+ def is_editable; end
287
+ alias_method :editable?, :is_editable
288
+
289
+ # Returns true if the control is single-line.
290
+ #
291
+ # Currently {Wx::RTC::RichTextCtrl} does not support single-line editing.
292
+ # @return [Boolean]
293
+ def is_single_line; end
294
+ alias_method :single_line?, :is_single_line
295
+
296
+ # Returns true if the control is multiline.
297
+ # @return [Boolean]
298
+ def is_multi_line; end
299
+ alias_method :multi_line?, :is_multi_line
300
+
301
+ # @return [Wx::RTC::RichTextSelection]
302
+ def get_selection; end
303
+ alias_method :selection, :get_selection
304
+
305
+ # Returns the text within the current selection range, if any.
306
+ # @return [String]
307
+ def get_string_selection; end
308
+ alias_method :string_selection, :get_string_selection
309
+
310
+ # Gets the current filename associated with the control.
311
+ # @return [String]
312
+ def get_filename; end
313
+ alias_method :filename, :get_filename
314
+
315
+ # Sets the current filename.
316
+ # @param filename [String]
317
+ # @return [void]
318
+ def set_filename(filename) end
319
+ alias_method :filename=, :set_filename
320
+
321
+ # Sets the size of the buffer beyond which layout is delayed during resizing.
322
+ #
323
+ # This optimizes sizing for large buffers. The default is 20000.
324
+ # @param threshold [Integer]
325
+ # @return [void]
326
+ def set_delayed_layout_threshold(threshold) end
327
+ alias_method :delayed_layout_threshold=, :set_delayed_layout_threshold
328
+
329
+ # Gets the size of the buffer beyond which layout is delayed during resizing.
330
+ #
331
+ # This optimizes sizing for large buffers. The default is 20000.
332
+ # @return [Integer]
333
+ def get_delayed_layout_threshold; end
334
+ alias_method :delayed_layout_threshold, :get_delayed_layout_threshold
335
+
336
+ # @return [Boolean]
337
+ def get_full_layout_required; end
338
+ alias_method :full_layout_required, :get_full_layout_required
339
+
340
+ # @param b [Boolean]
341
+ # @return [void]
342
+ def set_full_layout_required(b) end
343
+ alias_method :full_layout_required=, :set_full_layout_required
344
+
345
+ # @return [Integer]
346
+ def get_full_layout_time; end
347
+ alias_method :full_layout_time, :get_full_layout_time
348
+
349
+ # @param t [Integer]
350
+ # @return [void]
351
+ def set_full_layout_time(t) end
352
+ alias_method :full_layout_time=, :set_full_layout_time
353
+
354
+ # @return [Integer]
355
+ def get_full_layout_saved_position; end
356
+ alias_method :full_layout_saved_position, :get_full_layout_saved_position
357
+
358
+ # @param p [Integer]
359
+ # @return [void]
360
+ def set_full_layout_saved_position(p) end
361
+ alias_method :full_layout_saved_position=, :set_full_layout_saved_position
362
+
363
+ # @return [void]
364
+ def force_delayed_layout; end
365
+
366
+ # Sets the text (normal) cursor.
367
+ # @param cursor [Wx::Cursor]
368
+ # @return [void]
369
+ def set_text_cursor(cursor) end
370
+ alias_method :text_cursor=, :set_text_cursor
371
+
372
+ # Returns the text (normal) cursor.
373
+ # @return [Wx::Cursor]
374
+ def get_text_cursor; end
375
+ alias_method :text_cursor, :get_text_cursor
376
+
377
+ # Sets the cursor to be used over URLs.
378
+ # @param cursor [Wx::Cursor]
379
+ # @return [void]
380
+ def set_url_cursor(cursor) end
381
+ alias_method :url_cursor=, :set_url_cursor
382
+
383
+ # Returns the cursor to be used over URLs.
384
+ # @return [Wx::Cursor]
385
+ def get_url_cursor; end
386
+ alias_method :url_cursor, :get_url_cursor
387
+
388
+ # Returns true if we are showing the caret position at the start of a line instead of at the end of the previous one.
389
+ # @return [Boolean]
390
+ def get_caret_at_line_start; end
391
+ alias_method :caret_at_line_start, :get_caret_at_line_start
392
+
393
+ # Sets a flag to remember that we are showing the caret position at the start of a line instead of at the end of the previous one.
394
+ # @param atStart [Boolean]
395
+ # @return [void]
396
+ def set_caret_at_line_start(atStart) end
397
+ alias_method :caret_at_line_start=, :set_caret_at_line_start
398
+
399
+ # Returns true if we are extending a selection.
400
+ # @return [Boolean]
401
+ def get_dragging; end
402
+ alias_method :dragging, :get_dragging
403
+
404
+ # Sets a flag to remember if we are extending a selection.
405
+ # @param dragging [Boolean]
406
+ # @return [void]
407
+ def set_dragging(dragging) end
408
+ alias_method :dragging=, :set_dragging
409
+
410
+ # Are we trying to start Drag'n'Drop?
411
+ # @return [Boolean]
412
+ def get_pre_drag; end
413
+ alias_method :pre_drag, :get_pre_drag
414
+
415
+ # Set if we're trying to start Drag'n'Drop.
416
+ # @param pd [Boolean]
417
+ # @return [void]
418
+ def set_pre_drag(pd) end
419
+ alias_method :pre_drag=, :set_pre_drag
420
+
421
+ # Get the possible Drag'n'Drop start point.
422
+ # @return [Wx::Point]
423
+ def get_drag_start_point; end
424
+ alias_method :drag_start_point, :get_drag_start_point
425
+
426
+ # Set the possible Drag'n'Drop start point.
427
+ # @param sp [Wx::Point]
428
+ # @return [void]
429
+ def set_drag_start_point(sp) end
430
+ alias_method :drag_start_point=, :set_drag_start_point
431
+
432
+ # Get the possible Drag'n'Drop start time.
433
+ # @return [Wx::DateTime]
434
+ # @wxrb_require USE_DATETIME
435
+ def get_drag_start_time; end
436
+ alias_method :drag_start_time, :get_drag_start_time
437
+
438
+ # Set the possible Drag'n'Drop start time.
439
+ # @param st [Time,Date,DateTime]
440
+ # @return [void]
441
+ # @wxrb_require USE_DATETIME
442
+ def set_drag_start_time(st) end
443
+ alias_method :drag_start_time=, :set_drag_start_time
444
+
445
+ # Returns the current context menu.
446
+ # @return [Wx::Menu]
447
+ def get_context_menu; end
448
+ alias_method :context_menu, :get_context_menu
449
+
450
+ # Sets the current context menu.
451
+ # @param menu [Wx::Menu]
452
+ # @return [void]
453
+ def set_context_menu(menu) end
454
+
455
+ # Returns an anchor so we know how to extend the selection.
456
+ #
457
+ # It's a caret position since it's between two characters.
458
+ # @return [Integer]
459
+ def get_selection_anchor; end
460
+ alias_method :selection_anchor, :get_selection_anchor
461
+
462
+ # Sets an anchor so we know how to extend the selection.
463
+ #
464
+ # It's a caret position since it's between two characters.
465
+ # @param anchor [Integer]
466
+ # @return [void]
467
+ def set_selection_anchor(anchor) end
468
+ alias_method :selection_anchor=, :set_selection_anchor
469
+
470
+ # Returns the anchor object if selecting multiple containers.
471
+ # @return [Wx::RTC::RichTextObject]
472
+ def get_selection_anchor_object; end
473
+ alias_method :selection_anchor_object, :get_selection_anchor_object
474
+
475
+ # Sets the anchor object if selecting multiple containers.
476
+ # @param anchor [Wx::RTC::RichTextObject]
477
+ # @return [void]
478
+ def set_selection_anchor_object(anchor) end
479
+ alias_method :selection_anchor_object=, :set_selection_anchor_object
480
+
481
+ # @return [Wx::RTC::RichTextContextMenuPropertiesInfo]
482
+ def get_context_menu_properties_info; end
483
+ alias_method :context_menu_properties_info, :get_context_menu_properties_info
484
+
485
+ # Returns the {Wx::RTC::RichTextObject} object that currently has the editing focus.
486
+ #
487
+ # If there are no composite objects, this will be the top-level buffer.
488
+ # @return [Wx::RTC::RichTextParagraphLayoutBox]
489
+ def get_focus_object; end
490
+ alias_method :focus_object, :get_focus_object
491
+
492
+ # Setter for m_focusObject.
493
+ # @param obj [Wx::RTC::RichTextParagraphLayoutBox]
494
+ # @return [void]
495
+ def store_focus_object(obj) end
496
+
497
+ # Sets the {Wx::RTC::RichTextObject} object that currently has the editing focus.
498
+ # @param obj [Wx::RTC::RichTextParagraphLayoutBox] The {Wx::RTC::RichTextObject} to set focus on.
499
+ # @param setCaretPosition [Boolean] Optionally set the caret position.
500
+ # @return [Boolean]
501
+ def set_focus_object(obj, setCaretPosition=true) end
502
+ alias_method :focus_object=, :set_focus_object
503
+
504
+ # Invalidates the whole buffer to trigger painting later.
505
+ # @return [void]
506
+ def invalidate; end
507
+
508
+ # Clears the buffer content, leaving a single empty paragraph.
509
+ #
510
+ # Cannot be undone.
511
+ # @return [void]
512
+ def clear; end
513
+
514
+ # Replaces the content in the specified range with the string specified by value.
515
+ # @param from [Integer]
516
+ # @param to [Integer]
517
+ # @param value [String]
518
+ # @return [void]
519
+ def replace(from, to, value) end
520
+
521
+ # Removes the content in the specified range.
522
+ # @param from [Integer]
523
+ # @param to [Integer]
524
+ # @return [void]
525
+ def remove(from, to) end
526
+
527
+ # Loads content into the control's buffer using the given type.
528
+ #
529
+ # If the specified type is {Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY}, the type is deduced from the filename extension.
530
+ # This function looks for a suitable {Wx::RTC::RichTextFileHandler} object.
531
+ # @param file [String]
532
+ # @param type [Integer]
533
+ # @return [Boolean]
534
+ def load_file(file, type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY) end
535
+
536
+ # Helper function for {Wx::RTC::RichTextCtrl#load_file}.
537
+ #
538
+ # Loads content into the control's buffer using the given type.
539
+ # If the specified type is {Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY}, the type is deduced from the filename extension.
540
+ # This function looks for a suitable {Wx::RTC::RichTextFileHandler} object.
541
+ # @param file [String]
542
+ # @param fileType [Integer]
543
+ # @return [Boolean]
544
+ def do_load_file(file, fileType) end
545
+
546
+ # Saves the buffer content using the given type.
547
+ #
548
+ # If the specified type is {Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY}, the type is deduced from the filename extension.
549
+ # This function looks for a suitable {Wx::RTC::RichTextFileHandler} object.
550
+ # @param file [String]
551
+ # @param type [Integer]
552
+ # @return [Boolean]
553
+ def save_file(file=(''), type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY) end
554
+
555
+ # Helper function for {Wx::RTC::RichTextCtrl#save_file}.
556
+ #
557
+ # Saves the buffer content using the given type.
558
+ # If the specified type is {Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY}, the type is deduced from the filename extension.
559
+ # This function looks for a suitable {Wx::RTC::RichTextFileHandler} object.
560
+ # @param file [String]
561
+ # @param fileType [Integer]
562
+ # @return [Boolean]
563
+ def do_save_file(file=(''), fileType=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY) end
564
+
565
+ # Sets flags that change the behaviour of loading or saving.
566
+ #
567
+ # See the documentation for each handler class to see what flags are relevant for each handler.
568
+ # @param flags [Integer]
569
+ # @return [void]
570
+ def set_handler_flags(flags) end
571
+ alias_method :handler_flags=, :set_handler_flags
572
+
573
+ # Returns flags that change the behaviour of loading or saving.
574
+ #
575
+ # See the documentation for each handler class to see what flags are relevant for each handler.
576
+ # @return [Integer]
577
+ def get_handler_flags; end
578
+ alias_method :handler_flags, :get_handler_flags
579
+
580
+ # Marks the buffer as modified.
581
+ # @return [void]
582
+ def mark_dirty; end
583
+
584
+ # Sets the buffer's modified status to false, and clears the buffer's command history.
585
+ # @return [void]
586
+ def discard_edits; end
587
+
588
+ # @param modified [Boolean]
589
+ # @return [void]
590
+ def set_modified(modified) end
591
+ alias_method :modified=, :set_modified
592
+
593
+ # Sets the maximum number of characters that may be entered in a single line text control.
594
+ #
595
+ # For compatibility only; currently does nothing.
596
+ # @param len [Integer]
597
+ # @return [void]
598
+ def set_max_length(len) end
599
+ alias_method :max_length=, :set_max_length
600
+
601
+ # Writes text at the current position.
602
+ # @param text [String]
603
+ # @return [void]
604
+ def write_text(text) end
605
+
606
+ # Sets the insertion point to the end of the buffer and writes the text.
607
+ # @param text [String]
608
+ # @return [void]
609
+ def append_text(text) end
610
+
611
+ # @overload get_style(position, style)
612
+ # Gets the attributes at the given position.
613
+ #
614
+ # This function gets the combined style - that is, the style you see on the screen as a result of combining base style, paragraph style and character style attributes.
615
+ # To get the character or paragraph style alone, use {Wx::RTC::RichTextCtrl#get_uncombined_style}.
616
+ # @param position [Integer]
617
+ # @param style [Wx::TextAttr]
618
+ # @return [Boolean]
619
+ # @overload get_style(position, style)
620
+ # @param position [Integer]
621
+ # @param style [Wx::RTC::RichTextAttr]
622
+ # @return [Boolean]
623
+ # @overload get_style(position, style, container)
624
+ # @param position [Integer]
625
+ # @param style [Wx::RTC::RichTextAttr]
626
+ # @param container [Wx::RTC::RichTextParagraphLayoutBox]
627
+ # @return [Boolean]
628
+ def get_style(*args) end
629
+ alias_method :style, :get_style
630
+
631
+ # @overload set_style(start, end_, style)
632
+ # @param start [Integer]
633
+ # @param end_ [Integer]
634
+ # @param style [Wx::RTC::RichTextAttr]
635
+ # @return [Boolean]
636
+ # @overload set_style(range, style)
637
+ # @param range [Range]
638
+ # @param style [Wx::RTC::RichTextAttr]
639
+ # @return [Boolean]
640
+ def set_style(*args) end
641
+
642
+ # @overload get_style_for_range(range, style)
643
+ # @param range [Range]
644
+ # @param style [Wx::RTC::RichTextAttr]
645
+ # @return [Boolean]
646
+ # @overload get_style_for_range(range, style, container)
647
+ # @param range [Range]
648
+ # @param style [Wx::RTC::RichTextAttr]
649
+ # @param container [Wx::RTC::RichTextParagraphLayoutBox]
650
+ # @return [Boolean]
651
+ def get_style_for_range(*args) end
652
+ alias_method :style_for_range, :get_style_for_range
653
+
654
+ # Sets the attributes for the given range, passing flags to determine how the attributes are set.
655
+ #
656
+ # The end point of range is specified as the last character position of the span of text, plus one. So, for example, to set the style for a character at position 5, use the range (5,6).
657
+ # flags may contain a bit list of the following values:
658
+ #
659
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_NONE}: no style flag.
660
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this operation should be undoable.
661
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_OPTIMIZE}: specifies that the style should not be applied if the combined style at this point is already the style in question.
662
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_PARAGRAPHS_ONLY}: specifies that the style should only be applied to paragraphs, and not the content. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
663
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_CHARACTERS_ONLY}: specifies that the style should only be applied to characters, and not the paragraph. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
664
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_RESET}: resets (clears) the existing style before applying the new style.
665
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_REMOVE}: removes the specified style. Only the style flags are used in this operation.
666
+ # @param range [Range]
667
+ # @param style [Wx::RTC::RichTextAttr]
668
+ # @param flags [Integer]
669
+ # @return [Boolean]
670
+ def set_style_ex(range, style, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO) end
671
+
672
+ # @overload get_uncombined_style(position, style)
673
+ # Gets the attributes at the given position.
674
+ #
675
+ # This function gets the uncombined style - that is, the attributes associated with the paragraph or character content, and not necessarily the combined attributes you see on the screen. To get the combined attributes, use {Wx::RTC::RichTextCtrl#get_style}.
676
+ # If you specify (any) paragraph attribute in style's flags, this function will fetch the paragraph attributes. Otherwise, it will return the character attributes.
677
+ # @param position [Integer]
678
+ # @param style [Wx::RTC::RichTextAttr]
679
+ # @return [Boolean]
680
+ # @overload get_uncombined_style(position, style, container)
681
+ # @param position [Integer]
682
+ # @param style [Wx::RTC::RichTextAttr]
683
+ # @param container [Wx::RTC::RichTextParagraphLayoutBox]
684
+ # @return [Boolean]
685
+ def get_uncombined_style(*args) end
686
+ alias_method :uncombined_style, :get_uncombined_style
687
+
688
+ # @overload set_default_style(style)
689
+ # Sets the current default style, which can be used to change how subsequently inserted text is displayed.
690
+ # @param style [Wx::TextAttr]
691
+ # @return [Boolean]
692
+ # @overload set_default_style(style)
693
+ # @param style [Wx::RTC::RichTextAttr]
694
+ # @return [Boolean]
695
+ def set_default_style(*args) end
696
+ alias_method :default_style=, :set_default_style
697
+
698
+ # Returns the current default style, which can be used to change how subsequently inserted text is displayed.
699
+ # @return [Wx::RTC::RichTextAttr]
700
+ def get_default_style_ex; end
701
+ alias_method :default_style_ex, :get_default_style_ex
702
+
703
+ # @param range [Range]
704
+ # @param defName [String]
705
+ # @param flags [Integer]
706
+ # @param startFrom [Integer]
707
+ # @param specifiedLevel [Integer]
708
+ # @return [Boolean]
709
+ def set_list_style(range, defName, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1) end
710
+
711
+ # Clears the list style from the given range, clearing list-related attributes and applying any named paragraph style associated with each paragraph.
712
+ #
713
+ # flags is a bit list of the following:
714
+ #
715
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this command will be undoable.
716
+ # @see Wx::RTC::RichTextCtrl#set_list_style
717
+ # @see Wx::RTC::RichTextCtrl#promote_list
718
+ # @see Wx::RTC::RichTextCtrl#number_list.
719
+ # @param range [Range]
720
+ # @param flags [Integer]
721
+ # @return [Boolean]
722
+ def clear_list_style(range, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO) end
723
+
724
+ # @overload number_list(range, def_=nil, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1)
725
+ # Numbers the paragraphs in the given range.
726
+ #
727
+ # Pass flags to determine how the attributes are set.
728
+ # Either the style definition or the name of the style definition (in the current sheet) can be passed.
729
+ # flags is a bit list of the following:
730
+ #
731
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this command will be undoable.
732
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_RENUMBER}: specifies that numbering should start from startFrom, otherwise existing attributes are used.
733
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_SPECIFY_LEVEL}: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.
734
+ # @see Wx::RTC::RichTextCtrl#set_list_style
735
+ # @see Wx::RTC::RichTextCtrl#promote_list
736
+ # @see Wx::RTC::RichTextCtrl#clear_list_style.
737
+ # @param range [Range]
738
+ # @param def_ [Wx::RTC::RichTextListStyleDefinition]
739
+ # @param flags [Integer]
740
+ # @param startFrom [Integer]
741
+ # @param specifiedLevel [Integer]
742
+ # @return [Boolean]
743
+ # @overload number_list(range, defName, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1)
744
+ # @param range [Range]
745
+ # @param defName [String]
746
+ # @param flags [Integer]
747
+ # @param startFrom [Integer]
748
+ # @param specifiedLevel [Integer]
749
+ # @return [Boolean]
750
+ def number_list(*args) end
751
+
752
+ # @overload promote_list(promoteBy, range, def_=nil, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, specifiedLevel=-1)
753
+ # Promotes or demotes the paragraphs in the given range.
754
+ #
755
+ # A positive promoteBy produces a smaller indent, and a negative number produces a larger indent. Pass flags to determine how the attributes are set. Either the style definition or the name of the style definition (in the current sheet) can be passed.
756
+ # flags is a bit list of the following:
757
+ #
758
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this command will be undoable.
759
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_RENUMBER}: specifies that numbering should start from startFrom, otherwise existing attributes are used.
760
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_SPECIFY_LEVEL}: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.
761
+ # @see Wx::RTC::RichTextCtrl#set_list_style
762
+ # @see
763
+ #
764
+ # @see Wx::RTC::RichTextCtrl#set_list_style
765
+ # @see Wx::RTC::RichTextCtrl#clear_list_style.
766
+ # @param promoteBy [Integer]
767
+ # @param range [Range]
768
+ # @param def_ [Wx::RTC::RichTextListStyleDefinition]
769
+ # @param flags [Integer]
770
+ # @param specifiedLevel [Integer]
771
+ # @return [Boolean]
772
+ # @overload promote_list(promoteBy, range, defName, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, specifiedLevel=-1)
773
+ # @param promoteBy [Integer]
774
+ # @param range [Range]
775
+ # @param defName [String]
776
+ # @param flags [Integer]
777
+ # @param specifiedLevel [Integer]
778
+ # @return [Boolean]
779
+ def promote_list(*args) end
780
+
781
+ # Sets the properties for the given range, passing flags to determine how the attributes are set.
782
+ #
783
+ # You can merge properties or replace them.
784
+ # The end point of range is specified as the last character position of the span of text, plus one. So, for example, to set the properties for a character at position 5, use the range (5,6).
785
+ # flags may contain a bit list of the following values:
786
+ #
787
+ # - {Wx::RICHTEXT_SETSPROPERTIES_NONE}: no flag.
788
+ # - {Wx::RTC::RICHTEXT_SETPROPERTIES_WITH_UNDO}: specifies that this operation should be undoable.
789
+ # - {Wx::RTC::RICHTEXT_SETPROPERTIES_PARAGRAPHS_ONLY}: specifies that the properties should only be applied to paragraphs, and not the content.
790
+ # - {Wx::RTC::RICHTEXT_SETPROPERTIES_CHARACTERS_ONLY}: specifies that the properties should only be applied to characters, and not the paragraph.
791
+ # - {Wx::RTC::RICHTEXT_SETPROPERTIES_RESET}: resets (clears) the existing properties before applying the new properties.
792
+ # - {Wx::RTC::RICHTEXT_SETPROPERTIES_REMOVE}: removes the specified properties.
793
+ # @param range [Range]
794
+ # @param properties [Wx::RTC::RichTextProperties]
795
+ # @param flags [Integer]
796
+ # @return [Boolean]
797
+ def set_properties(range, properties, flags=Wx::RTC::RICHTEXT_SETPROPERTIES_WITH_UNDO) end
798
+
799
+ # Deletes the content within the given range.
800
+ # @param range [Range]
801
+ # @return [Boolean]
802
+ def delete(range) end
803
+
804
+ # Scrolls the buffer so that the given position is in view.
805
+ # @param pos [Integer]
806
+ # @return [void]
807
+ def show_position(pos) end
808
+
809
+ # @param pt [Array(Integer, Integer), Wx::Point]
810
+ # @return [Array(Wx::TextCtrlHitTestResult,Integer,Integer)]
811
+ def hit_test(pt) end
812
+
813
+ # Copies the selected content (if any) to the clipboard.
814
+ # @return [void]
815
+ def copy; end
816
+
817
+ # Copies the selected content (if any) to the clipboard and deletes the selection.
818
+ #
819
+ # This is undoable.
820
+ # @return [void]
821
+ def cut; end
822
+
823
+ # Pastes content from the clipboard to the buffer.
824
+ # @return [void]
825
+ def paste; end
826
+
827
+ # Deletes the content in the selection, if any.
828
+ #
829
+ # This is undoable.
830
+ # @return [void]
831
+ def delete_selection; end
832
+
833
+ # Returns true if selected content can be copied to the clipboard.
834
+ # @return [Boolean]
835
+ def can_copy; end
836
+ alias_method :can_copy?, :can_copy
837
+
838
+ # Returns true if selected content can be copied to the clipboard and deleted.
839
+ # @return [Boolean]
840
+ def can_cut; end
841
+ alias_method :can_cut?, :can_cut
842
+
843
+ # Returns true if the clipboard content can be pasted to the buffer.
844
+ # @return [Boolean]
845
+ def can_paste; end
846
+ alias_method :can_paste?, :can_paste
847
+
848
+ # Returns true if selected content can be deleted.
849
+ # @return [Boolean]
850
+ def can_delete_selection; end
851
+ alias_method :can_delete_selection?, :can_delete_selection
852
+
853
+ # Undoes the command at the top of the command history, if there is one.
854
+ # @return [void]
855
+ def undo; end
856
+
857
+ # Redoes the current command.
858
+ # @return [void]
859
+ def redo_; end
860
+
861
+ # Returns true if there is a command in the command history that can be undone.
862
+ # @return [Boolean]
863
+ def can_undo; end
864
+ alias_method :can_undo?, :can_undo
865
+
866
+ # Returns true if there is a command in the command history that can be redone.
867
+ # @return [Boolean]
868
+ def can_redo; end
869
+ alias_method :can_redo?, :can_redo
870
+
871
+ # Sets the insertion point and causes the current editing style to be taken from the new position (unlike {Wx::RTC::RichTextCtrl#set_caret_position}).
872
+ # @param pos [Integer]
873
+ # @return [void]
874
+ def set_insertion_point(pos) end
875
+ alias_method :insertion_point=, :set_insertion_point
876
+
877
+ # Sets the insertion point to the end of the text control.
878
+ # @return [void]
879
+ def set_insertion_point_end; end
880
+
881
+ # Returns the current insertion point.
882
+ # @return [Integer]
883
+ def get_insertion_point; end
884
+ alias_method :insertion_point, :get_insertion_point
885
+
886
+ # Returns the last position in the buffer.
887
+ # @return [Wx::TextPos]
888
+ def get_last_position; end
889
+ alias_method :last_position, :get_last_position
890
+
891
+ # @overload set_selection(from, to)
892
+ # Sets the selection to the given range.
893
+ #
894
+ # The end point of range is specified as the last character position of the span of text, plus one.
895
+ # So, for example, to set the selection for a character at position 5, use the range (5,6).
896
+ # @param from [Integer]
897
+ # @param to [Integer]
898
+ # @return [void]
899
+ # @overload set_selection(sel)
900
+ # @param sel [Wx::RTC::RichTextSelection]
901
+ # @return [void]
902
+ def set_selection(*args) end
903
+ alias_method :selection=, :set_selection
904
+
905
+ # Selects all the text in the buffer.
906
+ # @return [void]
907
+ def select_all; end
908
+
909
+ # Makes the control editable, or not.
910
+ # @param editable [Boolean]
911
+ # @return [void]
912
+ def set_editable(editable) end
913
+ alias_method :editable=, :set_editable
914
+
915
+ # Returns true if there is a selection and the object containing the selection was the same as the current focus object.
916
+ # @return [Boolean]
917
+ def has_selection; end
918
+ alias_method :has_selection?, :has_selection
919
+
920
+ # Returns true if there was a selection, whether or not the current focus object is the same as the selection's container object.
921
+ # @return [Boolean]
922
+ def has_unfocused_selection; end
923
+ alias_method :has_unfocused_selection?, :has_unfocused_selection
924
+
925
+ # @overload write_image(image, bitmapType=Wx::BitmapType::BITMAP_TYPE_PNG, textAttr=(Wx::RichTextAttr.new()))
926
+ # Write a bitmap or image at the current insertion point.
927
+ #
928
+ # Supply an optional type to use for internal and file storage of the raw data.
929
+ # @param image [Wx::Image]
930
+ # @param bitmapType [Wx::BitmapType]
931
+ # @param textAttr [Wx::RTC::RichTextAttr]
932
+ # @return [Boolean]
933
+ # @overload write_image(bitmap, bitmapType=Wx::BitmapType::BITMAP_TYPE_PNG, textAttr=(Wx::RichTextAttr.new()))
934
+ # @param bitmap [Wx::Bitmap]
935
+ # @param bitmapType [Wx::BitmapType]
936
+ # @param textAttr [Wx::RTC::RichTextAttr]
937
+ # @return [Boolean]
938
+ # @overload write_image(filename, bitmapType, textAttr=(Wx::RichTextAttr.new()))
939
+ # Loads an image from a file and writes it at the current insertion point.
940
+ # @param filename [String]
941
+ # @param bitmapType [Wx::BitmapType]
942
+ # @param textAttr [Wx::RTC::RichTextAttr]
943
+ # @return [Boolean]
944
+ # @overload write_image(imageBlock, textAttr=(Wx::RichTextAttr.new()))
945
+ # Writes an image block at the current insertion point.
946
+ # @param imageBlock [Wx::RTC::RichTextImageBlock]
947
+ # @param textAttr [Wx::RTC::RichTextAttr]
948
+ # @return [Boolean]
949
+ def write_image(*args) end
950
+
951
+ # Write a text box at the current insertion point, returning the text box.
952
+ #
953
+ # You can then call {Wx::RTC::RichTextCtrl#set_focus_object} to set the focus to the new object.
954
+ # @param textAttr [Wx::RTC::RichTextAttr]
955
+ # @return [Wx::RTC::RichTextBox]
956
+ def write_text_box(textAttr=(Wx::RichTextAttr.new())) end
957
+
958
+ # Writes a field at the current insertion point.
959
+ #
960
+ #
961
+ # @see Wx::RTC::RichTextField
962
+ # @see Wx::RTC::RichTextFieldType
963
+ # @see Wx::RTC::RichTextFieldTypeStandard
964
+ # @param fieldType [String] The field type, matching an existing field type definition.
965
+ # @param properties [Wx::RTC::RichTextProperties] Extra data for the field.
966
+ # @param textAttr [Wx::RTC::RichTextAttr] Optional attributes.
967
+ # @return [Wx::RTC::RichTextField]
968
+ def write_field(fieldType, properties, textAttr=(Wx::RichTextAttr.new())) end
969
+
970
+ # Write a table at the current insertion point, returning the table.
971
+ #
972
+ # You can then call {Wx::RTC::RichTextCtrl#set_focus_object} to set the focus to the new object.
973
+ # @param rows [Integer]
974
+ # @param cols [Integer]
975
+ # @param tableAttr [Wx::RTC::RichTextAttr]
976
+ # @param cellAttr [Wx::RTC::RichTextAttr]
977
+ # @return [Wx::RTC::RichTextTable]
978
+ def write_table(rows, cols, tableAttr=(Wx::RichTextAttr.new()), cellAttr=(Wx::RichTextAttr.new())) end
979
+
980
+ # Inserts a new paragraph at the current insertion point.
981
+ #
982
+ #
983
+ # @see Wx::RTC::RichTextCtrl#line_break.
984
+ # @return [Boolean]
985
+ def newline; end
986
+
987
+ # Inserts a line break at the current insertion point.
988
+ #
989
+ # A line break forces wrapping within a paragraph, and can be introduced by using this function, by appending the {Wx::Char} value <b>{Wx::RICH_TEXT_LINE_BREAK_CHAR}</b> to text content, or by typing Shift-Return.
990
+ # @return [Boolean]
991
+ def line_break; end
992
+
993
+ # Sets the basic (overall) style.
994
+ #
995
+ # This is the style of the whole buffer before further styles are applied, unlike the default style, which only affects the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold).
996
+ # @param style [Wx::RTC::RichTextAttr]
997
+ # @return [void]
998
+ def set_basic_style(style) end
999
+ alias_method :basic_style=, :set_basic_style
1000
+
1001
+ # Gets the basic (overall) style.
1002
+ #
1003
+ # This is the style of the whole buffer before further styles are applied, unlike the default style, which only affects the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold).
1004
+ # @return [Wx::RTC::RichTextAttr]
1005
+ def get_basic_style; end
1006
+ alias_method :basic_style, :get_basic_style
1007
+
1008
+ # Begins applying a style.
1009
+ # @param style [Wx::RTC::RichTextAttr]
1010
+ # @return [Boolean]
1011
+ def begin_style(style) end
1012
+
1013
+ # Ends the current style.
1014
+ # @return [Boolean]
1015
+ def end_style; end
1016
+
1017
+ # Ends application of all styles in the current style stack.
1018
+ # @return [Boolean]
1019
+ def end_all_styles; end
1020
+
1021
+ # Begins using bold.
1022
+ # @return [Boolean]
1023
+ def begin_bold; end
1024
+
1025
+ # Ends using bold.
1026
+ # @return [Boolean]
1027
+ def end_bold; end
1028
+
1029
+ # Begins using italic.
1030
+ # @return [Boolean]
1031
+ def begin_italic; end
1032
+
1033
+ # Ends using italic.
1034
+ # @return [Boolean]
1035
+ def end_italic; end
1036
+
1037
+ # Begins using underlining.
1038
+ # @return [Boolean]
1039
+ def begin_underline; end
1040
+
1041
+ # End applying underlining.
1042
+ # @return [Boolean]
1043
+ def end_underline; end
1044
+
1045
+ # Begins using the given point size.
1046
+ # @param pointSize [Integer]
1047
+ # @return [Boolean]
1048
+ def begin_font_size(pointSize) end
1049
+
1050
+ # Ends using a point size.
1051
+ # @return [Boolean]
1052
+ def end_font_size; end
1053
+
1054
+ # Begins using this font.
1055
+ # @param font [Wx::Font,Wx::FontInfo]
1056
+ # @return [Boolean]
1057
+ def begin_font(font) end
1058
+
1059
+ # Ends using a font.
1060
+ # @return [Boolean]
1061
+ def end_font; end
1062
+
1063
+ # Begins using this colour.
1064
+ # @param colour [Wx::Colour,String,Symbol]
1065
+ # @return [Boolean]
1066
+ def begin_text_colour(colour) end
1067
+
1068
+ # Ends applying a text colour.
1069
+ # @return [Boolean]
1070
+ def end_text_colour; end
1071
+
1072
+ # Begins using alignment.
1073
+ #
1074
+ # For alignment values, see {Wx::TextAttr}.
1075
+ # @param alignment [Wx::TextAttrAlignment]
1076
+ # @return [Boolean]
1077
+ def begin_alignment(alignment) end
1078
+
1079
+ # Ends alignment.
1080
+ # @return [Boolean]
1081
+ def end_alignment; end
1082
+
1083
+ # Begins applying a left indent and subindent in tenths of a millimetre.
1084
+ #
1085
+ # The subindent is an offset from the left edge of the paragraph, and is used for all but the first line in a paragraph. A positive value will cause the first line to appear to the left of the subsequent lines, and a negative value will cause the first line to be indented to the right of the subsequent lines.
1086
+ # {Wx::RTC::RichTextBuffer} uses indentation to render a bulleted item. The content of the paragraph, including the first line, starts at the leftIndent plus the leftSubIndent.
1087
+ # @param leftIndent [Integer] The distance between the margin and the bullet.
1088
+ # @param leftSubIndent [Integer] The distance between the left edge of the bullet and the left edge of the actual paragraph.
1089
+ # @return [Boolean]
1090
+ def begin_left_indent(leftIndent, leftSubIndent=0) end
1091
+
1092
+ # Ends left indent.
1093
+ # @return [Boolean]
1094
+ def end_left_indent; end
1095
+
1096
+ # Begins a right indent, specified in tenths of a millimetre.
1097
+ # @param rightIndent [Integer]
1098
+ # @return [Boolean]
1099
+ def begin_right_indent(rightIndent) end
1100
+
1101
+ # Ends right indent.
1102
+ # @return [Boolean]
1103
+ def end_right_indent; end
1104
+
1105
+ # Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing in tenths of a millimetre.
1106
+ # @param before [Integer]
1107
+ # @param after [Integer]
1108
+ # @return [Boolean]
1109
+ def begin_paragraph_spacing(before, after) end
1110
+
1111
+ # Ends paragraph spacing.
1112
+ # @return [Boolean]
1113
+ def end_paragraph_spacing; end
1114
+
1115
+ # Begins applying line spacing.
1116
+ #
1117
+ # spacing is a multiple, where 10 means single-spacing, 15 means 1.5 spacing, and 20 means double spacing.
1118
+ # The {Wx::TextAttrLineSpacing} constants are defined for convenience.
1119
+ # @param lineSpacing [Integer]
1120
+ # @return [Boolean]
1121
+ def begin_line_spacing(lineSpacing) end
1122
+
1123
+ # Ends line spacing.
1124
+ # @return [Boolean]
1125
+ def end_line_spacing; end
1126
+
1127
+ # Begins a numbered bullet.
1128
+ #
1129
+ # This call will be needed for each item in the list, and the application should take care of incrementing the numbering.
1130
+ # bulletNumber is a number, usually starting with 1. leftIndent and leftSubIndent are values in tenths of a millimetre. bulletStyle is a bitlist of the {Wx::TextAttrBulletStyle} values.
1131
+ # {Wx::RTC::RichTextBuffer} uses indentation to render a bulleted item. The left indent is the distance between the margin and the bullet. The content of the paragraph, including the first line, starts at leftMargin + leftSubIndent. So the distance between the left edge of the bullet and the left of the actual paragraph is leftSubIndent.
1132
+ # @param bulletNumber [Integer]
1133
+ # @param leftIndent [Integer]
1134
+ # @param leftSubIndent [Integer]
1135
+ # @param bulletStyle [Integer]
1136
+ # @return [Boolean]
1137
+ def begin_numbered_bullet(bulletNumber, leftIndent, leftSubIndent, bulletStyle=(Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_ARABIC|Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_PERIOD)) end
1138
+
1139
+ # Ends application of a numbered bullet.
1140
+ # @return [Boolean]
1141
+ def end_numbered_bullet; end
1142
+
1143
+ # Begins applying a symbol bullet, using a character from the current font.
1144
+ #
1145
+ # See {Wx::RTC::RichTextCtrl#begin_numbered_bullet} for an explanation of how indentation is used to render the bulleted paragraph.
1146
+ # @param symbol [String]
1147
+ # @param leftIndent [Integer]
1148
+ # @param leftSubIndent [Integer]
1149
+ # @param bulletStyle [Integer]
1150
+ # @return [Boolean]
1151
+ def begin_symbol_bullet(symbol, leftIndent, leftSubIndent, bulletStyle=Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_SYMBOL) end
1152
+
1153
+ # Ends applying a symbol bullet.
1154
+ # @return [Boolean]
1155
+ def end_symbol_bullet; end
1156
+
1157
+ # Begins applying a symbol bullet.
1158
+ # @param bulletName [String]
1159
+ # @param leftIndent [Integer]
1160
+ # @param leftSubIndent [Integer]
1161
+ # @param bulletStyle [Integer]
1162
+ # @return [Boolean]
1163
+ def begin_standard_bullet(bulletName, leftIndent, leftSubIndent, bulletStyle=Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_STANDARD) end
1164
+
1165
+ # Begins applying a standard bullet.
1166
+ # @return [Boolean]
1167
+ def end_standard_bullet; end
1168
+
1169
+ # Begins using the named character style.
1170
+ # @param characterStyle [String]
1171
+ # @return [Boolean]
1172
+ def begin_character_style(characterStyle) end
1173
+
1174
+ # Ends application of a named character style.
1175
+ # @return [Boolean]
1176
+ def end_character_style; end
1177
+
1178
+ # Begins applying the named paragraph style.
1179
+ # @param paragraphStyle [String]
1180
+ # @return [Boolean]
1181
+ def begin_paragraph_style(paragraphStyle) end
1182
+
1183
+ # Ends application of a named paragraph style.
1184
+ # @return [Boolean]
1185
+ def end_paragraph_style; end
1186
+
1187
+ # Begins using a specified list style.
1188
+ #
1189
+ # Optionally, you can also pass a level and a number.
1190
+ # @param listStyle [String]
1191
+ # @param level [Integer]
1192
+ # @param number [Integer]
1193
+ # @return [Boolean]
1194
+ def begin_list_style(listStyle, level=1, number=1) end
1195
+
1196
+ # Ends using a specified list style.
1197
+ # @return [Boolean]
1198
+ def end_list_style; end
1199
+
1200
+ # Begins applying {Wx::TextAttrFlags::TEXT_ATTR_URL} to the content.
1201
+ #
1202
+ # Pass a URL and optionally, a character style to apply, since it is common to mark a URL with a familiar style such as blue text with underlining.
1203
+ # @param url [String]
1204
+ # @param characterStyle [String]
1205
+ # @return [Boolean]
1206
+ def begin_url(url, characterStyle=('')) end
1207
+
1208
+ # Ends applying a URL.
1209
+ # @return [Boolean]
1210
+ def end_url; end
1211
+
1212
+ # Sets the default style to the style under the cursor.
1213
+ # @return [Boolean]
1214
+ def set_default_style_to_cursor_style; end
1215
+
1216
+ # Cancels any selection.
1217
+ # @return [void]
1218
+ def select_none; end
1219
+
1220
+ # Selects the word at the given character position.
1221
+ # @param position [Integer]
1222
+ # @return [Boolean]
1223
+ def select_word(position) end
1224
+
1225
+ # Returns the selection range in character positions.
1226
+ #
1227
+ # -1, -1 means no selection.
1228
+ # The range is in API convention, i.e. a single character selection is denoted by (n, n+1)
1229
+ # @return [Range]
1230
+ def get_selection_range; end
1231
+ alias_method :selection_range, :get_selection_range
1232
+
1233
+ # Sets the selection to the given range.
1234
+ #
1235
+ # The end point of range is specified as the last character position of the span of text, plus one.
1236
+ # So, for example, to set the selection for a character at position 5, use the range (5,6).
1237
+ # @param range [Range]
1238
+ # @return [void]
1239
+ def set_selection_range(range) end
1240
+ alias_method :selection_range=, :set_selection_range
1241
+
1242
+ # Returns the selection range in character positions.
1243
+ #
1244
+ # -2, -2 means no selection -1, -1 means select everything. The range is in internal format, i.e. a single character selection is denoted by (n, n)
1245
+ # @return [Range]
1246
+ def get_internal_selection_range; end
1247
+ alias_method :internal_selection_range, :get_internal_selection_range
1248
+
1249
+ # Sets the selection range in character positions.
1250
+ #
1251
+ # -2, -2 means no selection -1, -1 means select everything. The range is in internal format, i.e. a single character selection is denoted by (n, n)
1252
+ # @param range [Range]
1253
+ # @return [void]
1254
+ def set_internal_selection_range(range) end
1255
+ alias_method :internal_selection_range=, :set_internal_selection_range
1256
+
1257
+ # Adds a new paragraph of text to the end of the buffer.
1258
+ # @param text [String]
1259
+ # @return [Range]
1260
+ def add_paragraph(text) end
1261
+
1262
+ # Adds an image to the control's buffer.
1263
+ # @param image [Wx::Image]
1264
+ # @return [Range]
1265
+ def add_image(image) end
1266
+
1267
+ # Move the caret to the given character position.
1268
+ #
1269
+ # Please note that this does not update the current editing style from the new position; to do that, call {Wx::RTC::RichTextCtrl#set_insertion_point} instead.
1270
+ # @param pos [Integer]
1271
+ # @param showAtLineStart [Boolean]
1272
+ # @param container [Wx::RTC::RichTextParagraphLayoutBox]
1273
+ # @return [Boolean]
1274
+ def move_caret(pos, showAtLineStart=false, container=nil) end
1275
+
1276
+ # Moves right.
1277
+ # @param noPositions [Integer]
1278
+ # @param flags [Integer]
1279
+ # @return [Boolean]
1280
+ def move_right(noPositions=1, flags=0) end
1281
+
1282
+ # Moves left.
1283
+ # @param noPositions [Integer]
1284
+ # @param flags [Integer]
1285
+ # @return [Boolean]
1286
+ def move_left(noPositions=1, flags=0) end
1287
+
1288
+ # Moves to the start of the paragraph.
1289
+ # @param noLines [Integer]
1290
+ # @param flags [Integer]
1291
+ # @return [Boolean]
1292
+ def move_up(noLines=1, flags=0) end
1293
+
1294
+ # Moves the caret down.
1295
+ # @param noLines [Integer]
1296
+ # @param flags [Integer]
1297
+ # @return [Boolean]
1298
+ def move_down(noLines=1, flags=0) end
1299
+
1300
+ # Moves to the end of the line.
1301
+ # @param flags [Integer]
1302
+ # @return [Boolean]
1303
+ def move_to_line_end(flags=0) end
1304
+
1305
+ # Moves to the start of the line.
1306
+ # @param flags [Integer]
1307
+ # @return [Boolean]
1308
+ def move_to_line_start(flags=0) end
1309
+
1310
+ # Moves to the end of the paragraph.
1311
+ # @param flags [Integer]
1312
+ # @return [Boolean]
1313
+ def move_to_paragraph_end(flags=0) end
1314
+
1315
+ # Moves to the start of the paragraph.
1316
+ # @param flags [Integer]
1317
+ # @return [Boolean]
1318
+ def move_to_paragraph_start(flags=0) end
1319
+
1320
+ # Moves to the start of the buffer.
1321
+ # @param flags [Integer]
1322
+ # @return [Boolean]
1323
+ def move_home(flags=0) end
1324
+
1325
+ # Moves to the end of the buffer.
1326
+ # @param flags [Integer]
1327
+ # @return [Boolean]
1328
+ def move_end(flags=0) end
1329
+
1330
+ # Moves one or more pages up.
1331
+ # @param noPages [Integer]
1332
+ # @param flags [Integer]
1333
+ # @return [Boolean]
1334
+ def page_up(noPages=1, flags=0) end
1335
+
1336
+ # Moves one or more pages down.
1337
+ # @param noPages [Integer]
1338
+ # @param flags [Integer]
1339
+ # @return [Boolean]
1340
+ def page_down(noPages=1, flags=0) end
1341
+
1342
+ # Moves a number of words to the left.
1343
+ # @param noPages [Integer]
1344
+ # @param flags [Integer]
1345
+ # @return [Boolean]
1346
+ def word_left(noPages=1, flags=0) end
1347
+
1348
+ # Move a number of words to the right.
1349
+ # @param noPages [Integer]
1350
+ # @param flags [Integer]
1351
+ # @return [Boolean]
1352
+ def word_right(noPages=1, flags=0) end
1353
+
1354
+ # @return [Wx::RTC::RichTextBuffer]
1355
+ def get_buffer; end
1356
+ alias_method :buffer, :get_buffer
1357
+
1358
+ # Starts batching undo history for commands.
1359
+ # @param cmdName [String]
1360
+ # @return [Boolean]
1361
+ def begin_batch_undo(cmdName) end
1362
+
1363
+ # Ends batching undo command history.
1364
+ # @return [Boolean]
1365
+ def end_batch_undo; end
1366
+
1367
+ # Returns true if undo commands are being batched.
1368
+ # @return [Boolean]
1369
+ def batching_undo; end
1370
+
1371
+ # Starts suppressing undo history for commands.
1372
+ # @return [Boolean]
1373
+ def begin_suppress_undo; end
1374
+
1375
+ # Ends suppressing undo command history.
1376
+ # @return [Boolean]
1377
+ def end_suppress_undo; end
1378
+
1379
+ # Returns true if undo history suppression is on.
1380
+ # @return [Boolean]
1381
+ def suppressing_undo; end
1382
+
1383
+ # Test if this whole range has character attributes of the specified kind.
1384
+ #
1385
+ # If any of the attributes are different within the range, the test fails.
1386
+ # You can use this to implement, for example, bold button updating. style must have flags indicating which attributes are of interest.
1387
+ # @param range [Range]
1388
+ # @param style [Wx::RTC::RichTextAttr]
1389
+ # @return [Boolean]
1390
+ def has_character_attributes(range, style) end
1391
+ alias_method :has_character_attributes?, :has_character_attributes
1392
+
1393
+ # Test if this whole range has paragraph attributes of the specified kind.
1394
+ #
1395
+ # If any of the attributes are different within the range, the test fails. You can use this to implement, for example, centering button updating. style must have flags indicating which attributes are of interest.
1396
+ # @param range [Range]
1397
+ # @param style [Wx::RTC::RichTextAttr]
1398
+ # @return [Boolean]
1399
+ def has_paragraph_attributes(range, style) end
1400
+ alias_method :has_paragraph_attributes?, :has_paragraph_attributes
1401
+
1402
+ # Returns true if all of the selection, or the content at the caret position, is bold.
1403
+ # @return [Boolean]
1404
+ def is_selection_bold; end
1405
+ alias_method :selection_bold?, :is_selection_bold
1406
+
1407
+ # Returns true if all of the selection, or the content at the caret position, is italic.
1408
+ # @return [Boolean]
1409
+ def is_selection_italics; end
1410
+ alias_method :selection_italics?, :is_selection_italics
1411
+
1412
+ # Returns true if all of the selection, or the content at the caret position, is underlined.
1413
+ # @return [Boolean]
1414
+ def is_selection_underlined; end
1415
+ alias_method :selection_underlined?, :is_selection_underlined
1416
+
1417
+ # Returns true if all of the selection, or the content at the current caret position, has the supplied {Wx::TextAttrEffects} flag(s).
1418
+ # @param flag [Integer]
1419
+ # @return [Boolean]
1420
+ def does_selection_have_text_effect_flag(flag) end
1421
+
1422
+ # Returns true if all of the selection is aligned according to the specified flag.
1423
+ # @param alignment [Wx::TextAttrAlignment]
1424
+ # @return [Boolean]
1425
+ def is_selection_aligned(alignment) end
1426
+ alias_method :selection_aligned?, :is_selection_aligned
1427
+
1428
+ # Apples bold to the selection or the default style (undoable).
1429
+ # @return [Boolean]
1430
+ def apply_bold_to_selection; end
1431
+
1432
+ # Applies italic to the selection or the default style (undoable).
1433
+ # @return [Boolean]
1434
+ def apply_italic_to_selection; end
1435
+
1436
+ # Applies underline to the selection or the default style (undoable).
1437
+ # @return [Boolean]
1438
+ def apply_underline_to_selection; end
1439
+
1440
+ # Applies one or more {Wx::TextAttrEffects} flags to the selection (undoable).
1441
+ #
1442
+ # If there is no selection, it is applied to the default style.
1443
+ # @param flags [Integer]
1444
+ # @return [Boolean]
1445
+ def apply_text_effect_to_selection(flags) end
1446
+
1447
+ # Applies the given alignment to the selection or the default style (undoable).
1448
+ #
1449
+ # For alignment values, see {Wx::TextAttr}.
1450
+ # @param alignment [Wx::TextAttrAlignment]
1451
+ # @return [Boolean]
1452
+ def apply_alignment_to_selection(alignment) end
1453
+
1454
+ # Applies the style sheet to the buffer, matching paragraph styles in the sheet against named styles in the buffer.
1455
+ #
1456
+ # This might be useful if the styles have changed. If sheet is nil, the sheet set with {Wx::RTC::RichTextCtrl#set_style_sheet} is used. Currently this applies paragraph styles only.
1457
+ # @param def_ [Wx::RTC::RichTextStyleDefinition]
1458
+ # @return [Boolean]
1459
+ def apply_style(def_) end
1460
+
1461
+ # Sets the style sheet associated with the control.
1462
+ #
1463
+ # A style sheet allows named character and paragraph styles to be applied.
1464
+ # @param styleSheet [Wx::RTC::RichTextStyleSheet]
1465
+ # @return [void]
1466
+ def set_style_sheet(styleSheet) end
1467
+ alias_method :style_sheet=, :set_style_sheet
1468
+
1469
+ # Returns the style sheet associated with the control, if any.
1470
+ #
1471
+ # A style sheet allows named character and paragraph styles to be applied.
1472
+ # @return [Wx::RTC::RichTextStyleSheet]
1473
+ def get_style_sheet; end
1474
+ alias_method :style_sheet, :get_style_sheet
1475
+
1476
+ # Push the style sheet to top of stack.
1477
+ # @param styleSheet [Wx::RTC::RichTextStyleSheet]
1478
+ # @return [Boolean]
1479
+ def push_style_sheet(styleSheet) end
1480
+
1481
+ # Pops the style sheet from top of stack.
1482
+ # @return [Wx::RTC::RichTextStyleSheet]
1483
+ def pop_style_sheet; end
1484
+
1485
+ # Applies the style sheet to the buffer, for example if the styles have changed.
1486
+ # @param styleSheet [Wx::RTC::RichTextStyleSheet]
1487
+ # @return [Boolean]
1488
+ def apply_style_sheet(styleSheet=nil) end
1489
+
1490
+ # Shows the given context menu, optionally adding appropriate property-editing commands for the current position in the object hierarchy.
1491
+ # @param menu [Wx::Menu]
1492
+ # @param pt [Array(Integer, Integer), Wx::Point]
1493
+ # @param addPropertyCommands [Boolean]
1494
+ # @return [Boolean]
1495
+ def show_context_menu(menu, pt, addPropertyCommands) end
1496
+
1497
+ # Returns true if we can edit the object's properties via a GUI.
1498
+ # @param obj [Wx::RTC::RichTextObject]
1499
+ # @return [Boolean]
1500
+ def can_edit_properties(obj) end
1501
+ alias_method :can_edit_properties?, :can_edit_properties
1502
+
1503
+ # Edits the object's properties via a GUI.
1504
+ # @param obj [Wx::RTC::RichTextObject]
1505
+ # @param parent [Wx::Window]
1506
+ # @return [Boolean]
1507
+ def edit_properties(obj, parent) end
1508
+
1509
+ # Gets the object's properties menu label.
1510
+ # @param obj [Wx::RTC::RichTextObject]
1511
+ # @return [String]
1512
+ def get_properties_menu_label(obj) end
1513
+ alias_method :properties_menu_label, :get_properties_menu_label
1514
+
1515
+ # Prepares the content just before insertion (or after buffer reset).
1516
+ #
1517
+ # Called by the same function in {Wx::RTC::RichTextBuffer}. Currently is only called if undo mode is on.
1518
+ # @param container [Wx::RTC::RichTextParagraphLayoutBox]
1519
+ # @return [void]
1520
+ def prepare_content(container) end
1521
+
1522
+ # Can we delete this range?
1523
+ #
1524
+ # Sends an event to the control.
1525
+ # @param container [Wx::RTC::RichTextParagraphLayoutBox]
1526
+ # @param range [Range]
1527
+ # @return [Boolean]
1528
+ def can_delete_range(container, range) end
1529
+ alias_method :can_delete_range?, :can_delete_range
1530
+
1531
+ # Can we insert content at this position?
1532
+ #
1533
+ # Sends an event to the control.
1534
+ # @param container [Wx::RTC::RichTextParagraphLayoutBox]
1535
+ # @param pos [Integer]
1536
+ # @return [Boolean]
1537
+ def can_insert_content(container, pos) end
1538
+ alias_method :can_insert_content?, :can_insert_content
1539
+
1540
+ # Sets the scale factor for displaying fonts, for example for more comfortable editing.
1541
+ # @param fontScale [Float]
1542
+ # @param refresh [Boolean]
1543
+ # @return [void]
1544
+ def set_font_scale(fontScale, refresh=false) end
1545
+ alias_method :font_scale=, :set_font_scale
1546
+
1547
+ # Returns the scale factor for displaying fonts, for example for more comfortable editing.
1548
+ # @return [Float]
1549
+ def get_font_scale; end
1550
+ alias_method :font_scale, :get_font_scale
1551
+
1552
+ # Sets the scale factor for displaying certain dimensions such as indentation and inter-paragraph spacing.
1553
+ #
1554
+ # This can be useful when editing in a small control where you still want legible text, but a minimum of wasted white space.
1555
+ # @param dimScale [Float]
1556
+ # @param refresh [Boolean]
1557
+ # @return [void]
1558
+ def set_dimension_scale(dimScale, refresh=false) end
1559
+ alias_method :dimension_scale=, :set_dimension_scale
1560
+
1561
+ # Returns the scale factor for displaying certain dimensions such as indentation and inter-paragraph spacing.
1562
+ # @return [Float]
1563
+ def get_dimension_scale; end
1564
+ alias_method :dimension_scale, :get_dimension_scale
1565
+
1566
+ # Sets an overall scale factor for displaying and editing the content.
1567
+ # @param scale [Float]
1568
+ # @param refresh [Boolean]
1569
+ # @return [void]
1570
+ def set_scale(scale, refresh=false) end
1571
+ alias_method :scale=, :set_scale
1572
+
1573
+ # Returns an overall scale factor for displaying and editing the content.
1574
+ # @return [Float]
1575
+ def get_scale; end
1576
+ alias_method :scale, :get_scale
1577
+
1578
+ # Returns an unscaled point.
1579
+ # @param pt [Array(Integer, Integer), Wx::Point]
1580
+ # @return [Wx::Point]
1581
+ def get_unscaled_point(pt) end
1582
+ alias_method :unscaled_point, :get_unscaled_point
1583
+
1584
+ # Returns a scaled point.
1585
+ # @param pt [Array(Integer, Integer), Wx::Point]
1586
+ # @return [Wx::Point]
1587
+ def get_scaled_point(pt) end
1588
+ alias_method :scaled_point, :get_scaled_point
1589
+
1590
+ # Returns an unscaled size.
1591
+ # @param sz [Array(Integer, Integer), Wx::Size]
1592
+ # @return [Wx::Size]
1593
+ def get_unscaled_size(sz) end
1594
+ alias_method :unscaled_size, :get_unscaled_size
1595
+
1596
+ # Returns a scaled size.
1597
+ # @param sz [Array(Integer, Integer), Wx::Size]
1598
+ # @return [Wx::Size]
1599
+ def get_scaled_size(sz) end
1600
+ alias_method :scaled_size, :get_scaled_size
1601
+
1602
+ # Returns an unscaled rectangle.
1603
+ # @param rect [Wx::Rect]
1604
+ # @return [Wx::Rect]
1605
+ def get_unscaled_rect(rect) end
1606
+ alias_method :unscaled_rect, :get_unscaled_rect
1607
+
1608
+ # Returns a scaled rectangle.
1609
+ # @param rect [Wx::Rect]
1610
+ # @return [Wx::Rect]
1611
+ def get_scaled_rect(rect) end
1612
+ alias_method :scaled_rect, :get_scaled_rect
1613
+
1614
+ # Returns true if this control can use virtual attributes and virtual text.
1615
+ #
1616
+ # The default is false.
1617
+ # @return [Boolean]
1618
+ def get_virtual_attributes_enabled; end
1619
+ alias_method :virtual_attributes_enabled, :get_virtual_attributes_enabled
1620
+
1621
+ # Pass true to let the control use virtual attributes.
1622
+ #
1623
+ # The default is false.
1624
+ # @param b [Boolean]
1625
+ # @return [void]
1626
+ def enable_virtual_attributes(b) end
1627
+
1628
+ # Sends the event to the control.
1629
+ # @param event [Wx::CommandEvent]
1630
+ # @return [void]
1631
+ def command(event) end
1632
+
1633
+ # Sets the font, and also the basic and default attributes (see {Wx::RTC::RichTextCtrl#set_default_style}).
1634
+ # @param font [Wx::Font,Wx::FontInfo]
1635
+ # @return [Boolean]
1636
+ def set_font(font) end
1637
+ alias_method :font=, :set_font
1638
+
1639
+ # Return true from here to allow the colours of this window to be changed by {Wx::RTC::RichTextCtrl#inherit_attributes}.
1640
+ #
1641
+ # Returning false forbids inheriting them from the parent window.
1642
+ # The base class version returns false, but this method is overridden in {Wx::Control} where it returns true.
1643
+ # @return [Boolean]
1644
+ def should_inherit_colours; end
1645
+
1646
+ # Internal function to position the visible caret according to the current caret position.
1647
+ # @param container [Wx::RTC::RichTextParagraphLayoutBox]
1648
+ # @return [void]
1649
+ def position_caret(container=nil) end
1650
+
1651
+ # Helper function for extending the selection, returning true if the selection was changed.
1652
+ #
1653
+ # Selections are in caret positions.
1654
+ # @param oldPosition [Integer]
1655
+ # @param newPosition [Integer]
1656
+ # @param flags [Integer]
1657
+ # @return [Boolean]
1658
+ def extend_selection(oldPosition, newPosition, flags) end
1659
+
1660
+ # Extends a table selection in the given direction.
1661
+ # @param table [Wx::RTC::RichTextTable]
1662
+ # @param noRowSteps [Integer]
1663
+ # @param noColSteps [Integer]
1664
+ # @return [Boolean]
1665
+ def extend_cell_selection(table, noRowSteps, noColSteps) end
1666
+
1667
+ # Starts selecting table cells.
1668
+ # @param table [Wx::RTC::RichTextTable]
1669
+ # @param newCell [Wx::RTC::RichTextParagraphLayoutBox]
1670
+ # @return [Boolean]
1671
+ def start_cell_selection(table, newCell) end
1672
+
1673
+ # Refreshes the area affected by a selection change.
1674
+ # @param oldSelection [Wx::RTC::RichTextSelection]
1675
+ # @param newSelection [Wx::RTC::RichTextSelection]
1676
+ # @return [Boolean]
1677
+ def refresh_for_selection_change(oldSelection, newSelection) end
1678
+
1679
+ # Sets the caret position.
1680
+ #
1681
+ # The caret position is the character position just before the caret. A value of -1 means the caret is at the start of the buffer. Please note that this does not update the current editing style from the new position or cause the actual caret to be refreshed; to do that, call {Wx::RTC::RichTextCtrl#set_insertion_point} instead.
1682
+ # @param position [Integer]
1683
+ # @param showAtLineStart [Boolean]
1684
+ # @return [void]
1685
+ def set_caret_position(position, showAtLineStart=false) end
1686
+ alias_method :caret_position=, :set_caret_position
1687
+
1688
+ # Returns the current caret position.
1689
+ # @return [Integer]
1690
+ def get_caret_position; end
1691
+ alias_method :caret_position, :get_caret_position
1692
+
1693
+ # The adjusted caret position is the character position adjusted to take into account whether we're at the start of a paragraph, in which case style information should be taken from the next position, not current one.
1694
+ # @param caretPos [Integer]
1695
+ # @return [Integer]
1696
+ def get_adjusted_caret_position(caretPos) end
1697
+ alias_method :adjusted_caret_position, :get_adjusted_caret_position
1698
+
1699
+ # Move the caret one visual step forward: this may mean setting a flag and keeping the same position if we're going from the end of one line to the start of the next, which may be the exact same caret position.
1700
+ # @param oldPosition [Integer]
1701
+ # @return [void]
1702
+ def move_caret_forward(oldPosition) end
1703
+
1704
+ # Move the caret one visual step forward: this may mean setting a flag and keeping the same position if we're going from the end of one line to the start of the next, which may be the exact same caret position.
1705
+ # @param oldPosition [Integer]
1706
+ # @return [void]
1707
+ def move_caret_back(oldPosition) end
1708
+
1709
+ # Returns the caret height and position for the given character position.
1710
+ #
1711
+ # If container is null, the current focus object will be used.
1712
+ # @param position [Integer]
1713
+ # @param rect [Wx::Rect]
1714
+ # @param container [Wx::RTC::RichTextParagraphLayoutBox]
1715
+ # @return [Boolean]
1716
+ def get_caret_position_for_index(position, rect, container=nil) end
1717
+ alias_method :caret_position_for_index, :get_caret_position_for_index
1718
+
1719
+ # Internal helper function returning the line for the visible caret position.
1720
+ #
1721
+ # If the caret is shown at the very end of the line, it means the next character is actually on the following line. So this function gets the line we're expecting to find if this is the case.
1722
+ # @param caretPosition [Integer]
1723
+ # @return [Wx::RTC::RichTextLine]
1724
+ def get_visible_line_for_caret_position(caretPosition) end
1725
+ alias_method :visible_line_for_caret_position, :get_visible_line_for_caret_position
1726
+
1727
+ # Gets the command processor associated with the control's buffer.
1728
+ # @return [Wx::RTC::CommandProcessor]
1729
+ def get_command_processor; end
1730
+ alias_method :command_processor, :get_command_processor
1731
+
1732
+ # Deletes content if there is a selection, e.g.
1733
+ #
1734
+ # when pressing a key. Returns the new caret position in newPos, or leaves it if there was no action. This is undoable.
1735
+ # @return [Integer,nil]
1736
+ def delete_selected_content; end
1737
+
1738
+ # Transforms logical (unscrolled) position to physical window position.
1739
+ # @param ptLogical [Array(Integer, Integer), Wx::Point]
1740
+ # @return [Wx::Point]
1741
+ def get_physical_point(ptLogical) end
1742
+ alias_method :physical_point, :get_physical_point
1743
+
1744
+ # Transforms physical window position to logical (unscrolled) position.
1745
+ # @param ptPhysical [Array(Integer, Integer), Wx::Point]
1746
+ # @return [Wx::Point]
1747
+ def get_logical_point(ptPhysical) end
1748
+ alias_method :logical_point, :get_logical_point
1749
+
1750
+ # Helper function for finding the caret position for the next word.
1751
+ #
1752
+ # Direction is 1 (forward) or -1 (backwards).
1753
+ # @param direction [Integer]
1754
+ # @return [Integer]
1755
+ def find_next_word_position(direction=1) end
1756
+
1757
+ # Returns true if the given position is visible on the screen.
1758
+ # @param pos [Integer]
1759
+ # @return [Boolean]
1760
+ def is_position_visible(pos) end
1761
+ alias_method :position_visible?, :is_position_visible
1762
+
1763
+ # Returns the first visible position in the current view.
1764
+ # @return [Integer]
1765
+ def get_first_visible_position; end
1766
+ alias_method :first_visible_position, :get_first_visible_position
1767
+
1768
+ # Enable or disable images.
1769
+ # @param b [Boolean]
1770
+ # @return [void]
1771
+ def enable_images(b) end
1772
+
1773
+ # Returns true if images are enabled.
1774
+ # @return [Boolean]
1775
+ def get_images_enabled; end
1776
+ alias_method :images_enabled, :get_images_enabled
1777
+
1778
+ # Enable or disable delayed image loading.
1779
+ # @param b [Boolean]
1780
+ # @return [void]
1781
+ def enable_delayed_image_loading(b) end
1782
+
1783
+ # Returns true if delayed image loading is enabled.
1784
+ # @return [Boolean]
1785
+ def get_delayed_image_loading; end
1786
+ alias_method :delayed_image_loading, :get_delayed_image_loading
1787
+
1788
+ # Gets the flag indicating that delayed image processing is required.
1789
+ # @return [Boolean]
1790
+ def get_delayed_image_processing_required; end
1791
+ alias_method :delayed_image_processing_required, :get_delayed_image_processing_required
1792
+
1793
+ # Sets the flag indicating that delayed image processing is required.
1794
+ # @param b [Boolean]
1795
+ # @return [void]
1796
+ def set_delayed_image_processing_required(b) end
1797
+ alias_method :delayed_image_processing_required=, :set_delayed_image_processing_required
1798
+
1799
+ # Returns the last time delayed image processing was performed.
1800
+ # @return [Integer]
1801
+ def get_delayed_image_processing_time; end
1802
+ alias_method :delayed_image_processing_time, :get_delayed_image_processing_time
1803
+
1804
+ # Sets the last time delayed image processing was performed.
1805
+ # @param t [Integer]
1806
+ # @return [void]
1807
+ def set_delayed_image_processing_time(t) end
1808
+ alias_method :delayed_image_processing_time=, :set_delayed_image_processing_time
1809
+
1810
+ # Returns the caret position since the default formatting was changed.
1811
+ #
1812
+ # As soon as this position changes, we no longer reflect the default style in the UI. A value of -2 means that we should only reflect the style of the content under the caret.
1813
+ # @return [Integer]
1814
+ def get_caret_position_for_default_style; end
1815
+ alias_method :caret_position_for_default_style, :get_caret_position_for_default_style
1816
+
1817
+ # Set the caret position for the default style that the user is selecting.
1818
+ # @param pos [Integer]
1819
+ # @return [void]
1820
+ def set_caret_position_for_default_style(pos) end
1821
+ alias_method :caret_position_for_default_style=, :set_caret_position_for_default_style
1822
+
1823
+ # Returns true if the user has recently set the default style without moving the caret, and therefore the UI needs to reflect the default style and not the style at the caret.
1824
+ #
1825
+ # Below is an example of code that uses this function to determine whether the UI should show that the current style is bold.
1826
+ # @see Wx::RTC::RichTextCtrl#set_and_show_default_style.
1827
+ # @return [Boolean]
1828
+ def is_default_style_showing; end
1829
+ alias_method :default_style_showing?, :is_default_style_showing
1830
+
1831
+ # Sets attr as the default style and tells the control that the UI should reflect this attribute until the user moves the caret.
1832
+ #
1833
+ #
1834
+ # @see Wx::RTC::RichTextCtrl#is_default_style_showing.
1835
+ # @param attr [Wx::RTC::RichTextAttr]
1836
+ # @return [void]
1837
+ def set_and_show_default_style(attr) end
1838
+ alias_method :and_show_default_style=, :set_and_show_default_style
1839
+
1840
+ # Returns the first visible point in the window.
1841
+ # @return [Wx::Point]
1842
+ def get_first_visible_point; end
1843
+ alias_method :first_visible_point, :get_first_visible_point
1844
+
1845
+ # Returns the content of the entire control as a string.
1846
+ # @return [String]
1847
+ def get_value; end
1848
+ alias_method :value, :get_value
1849
+
1850
+ # Replaces existing content with the given text.
1851
+ # @param value [String]
1852
+ # @return [void]
1853
+ def set_value(value) end
1854
+ alias_method :value=, :set_value
1855
+
1856
+ # Processes the back key.
1857
+ # @param event [Wx::KeyEvent]
1858
+ # @param flags [Integer]
1859
+ # @return [Boolean]
1860
+ def process_back_key(event, flags) end
1861
+
1862
+ # Given a character position at which there is a list style, find the range encompassing the same list style by looking backwards and forwards.
1863
+ # @param pos [Integer]
1864
+ # @return [Array(Range,Boolean)]
1865
+ def find_range_for_list(pos) end
1866
+
1867
+ # Sets up the caret for the given position and container, after a mouse click.
1868
+ # @param container [Wx::RTC::RichTextParagraphLayoutBox]
1869
+ # @param position [Integer]
1870
+ # @param hitTestFlags [Integer]
1871
+ # @param extendSelection [Boolean]
1872
+ # @return [Boolean]
1873
+ def set_caret_position_after_click(container, position, hitTestFlags, extendSelection=false) end
1874
+
1875
+ # Find the caret position for the combination of hit-test flags and character position.
1876
+ #
1877
+ # Returns the caret position and also an indication of where to place the caret (caretLineStart) since this is ambiguous (same position used for end of line and start of next).
1878
+ # @param position [Integer]
1879
+ # @param hitTestFlags [Integer]
1880
+ # @param container [Wx::RTC::RichTextParagraphLayoutBox]
1881
+ # @return [Array(Integer,Boolean)]
1882
+ def find_caret_position_for_character_position(position, hitTestFlags, container) end
1883
+
1884
+ # Processes mouse movement in order to change the cursor.
1885
+ # @param container [Wx::RTC::RichTextParagraphLayoutBox]
1886
+ # @param obj [Wx::RTC::RichTextObject]
1887
+ # @param position [Integer]
1888
+ # @param pos [Array(Integer, Integer), Wx::Point]
1889
+ # @return [Boolean]
1890
+ def process_mouse_movement(container, obj, position, pos) end
1891
+
1892
+ # @overload process_delayed_image_loading(refresh)
1893
+ # Do delayed image loading and garbage-collect other images.
1894
+ # @param refresh [Boolean]
1895
+ # @return [Boolean]
1896
+ # @overload process_delayed_image_loading(screenRect, box)
1897
+ # @param screenRect [Wx::Rect]
1898
+ # @param box [Wx::RTC::RichTextParagraphLayoutBox]
1899
+ # @return [Array(Boolean,Integer)]
1900
+ def process_delayed_image_loading(*args) end
1901
+
1902
+ # Request delayed image processing.
1903
+ # @return [void]
1904
+ def request_delayed_image_processing; end
1905
+
1906
+ # Respond to timer events.
1907
+ # @param event [Wx::TimerEvent]
1908
+ # @return [void]
1909
+ def on_timer(event) end
1910
+
1911
+ # Font names take a long time to retrieve, so cache them (on demand).
1912
+ # @return [Wx::ArrayString]
1913
+ def self.get_available_font_names; end
1914
+
1915
+ # Clears the cache of available font names.
1916
+ # @return [void]
1917
+ def self.clear_available_font_names; end
1918
+
1919
+ end # RichTextCtrl
1920
+
1921
+ # {Wx::RTC::RichTextContextMenuPropertiesInfo} keeps track of objects that appear in the context menu, whose properties are available to be edited.
1922
+ #
1923
+ #
1924
+ #
1925
+ #
1926
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
1927
+ # @wxrb_require USE_RICHTEXT
1928
+ class RichTextContextMenuPropertiesInfo < ::Object
1929
+
1930
+ # Constructor.
1931
+ # @return [Wx::RTC::RichTextContextMenuPropertiesInfo]
1932
+ def initialize; end
1933
+
1934
+ # Initialisation.
1935
+ # @return [void]
1936
+ def init; end
1937
+
1938
+ # Adds an item.
1939
+ # @param label [String]
1940
+ # @param obj [Wx::RTC::RichTextObject]
1941
+ # @return [Boolean]
1942
+ def add_item(label, obj) end
1943
+
1944
+ # Returns the number of menu items that were added.
1945
+ # @param menu [Wx::Menu]
1946
+ # @param startCmd [Integer]
1947
+ # @return [Integer]
1948
+ def add_menu_items(menu, startCmd=wxID_RICHTEXT_PROPERTIES1) end
1949
+
1950
+ # Adds appropriate menu items for the current container and clicked on object (and container's parent, if appropriate).
1951
+ # @param ctrl [Wx::RTC::RichTextCtrl]
1952
+ # @param container [Wx::RTC::RichTextObject]
1953
+ # @param obj [Wx::RTC::RichTextObject]
1954
+ # @return [Integer]
1955
+ def add_items(ctrl, container, obj) end
1956
+
1957
+ # Clears the items.
1958
+ # @return [void]
1959
+ def clear; end
1960
+
1961
+ # Returns the nth label.
1962
+ # @param n [Integer]
1963
+ # @return [String]
1964
+ def get_label(n) end
1965
+ alias_method :label, :get_label
1966
+
1967
+ # Returns the nth object.
1968
+ # @param n [Integer]
1969
+ # @return [Wx::RTC::RichTextObject]
1970
+ def get_object(n) end
1971
+ alias_method :object, :get_object
1972
+
1973
+ # Returns the array of objects.
1974
+ # @return [Array<Wx::RTC::RichTextObject>]
1975
+ def get_objects; end
1976
+ alias_method :objects, :get_objects
1977
+
1978
+ # Returns the array of labels.
1979
+ # @return [Wx::ArrayString]
1980
+ def get_labels; end
1981
+ alias_method :labels, :get_labels
1982
+
1983
+ # Returns the number of items.
1984
+ # @return [Integer]
1985
+ def get_count; end
1986
+ alias_method :count, :get_count
1987
+
1988
+ end # RichTextContextMenuPropertiesInfo
1989
+
1990
+ # {Wx::RTC::CommandProcessor} is a class that maintains a history of {Wx::Commands}, with undo/redo functionality built-in.
1991
+ #
1992
+ # Derive a new class from this if you want different behaviour.
1993
+ #
1994
+ # Category: Document/View Framework
1995
+ # @see wxCommandProcessor Overview
1996
+ # @see Wx::Command
1997
+ #
1998
+ #
1999
+ # @wxrb_require USE_RICHTEXT
2000
+ class CommandProcessor < Object
2001
+
2002
+ # Constructor.
2003
+ # @param maxCommands [Integer] May be set to a positive integer to limit the number of commands stored to it, otherwise (and by default) the list of commands can grow arbitrarily.
2004
+ # @return [Wx::RTC::CommandProcessor]
2005
+ def initialize(maxCommands=-1) end
2006
+
2007
+ # Returns true if the currently-active command can be undone, false otherwise.
2008
+ # @return [Boolean]
2009
+ def can_undo; end
2010
+ alias_method :can_undo?, :can_undo
2011
+
2012
+ # Returns true if the currently-active command can be redone, false otherwise.
2013
+ # @return [Boolean]
2014
+ def can_redo; end
2015
+ alias_method :can_redo?, :can_redo
2016
+
2017
+ # Deletes all commands in the list and sets the current command pointer to nil.
2018
+ # @return [void]
2019
+ def clear_commands; end
2020
+
2021
+ # Returns the edit menu associated with the command processor.
2022
+ # @return [Wx::Menu]
2023
+ def get_edit_menu; end
2024
+ alias_method :edit_menu, :get_edit_menu
2025
+
2026
+ # Returns the maximum number of commands that the command processor stores.
2027
+ # @return [Integer]
2028
+ def get_max_commands; end
2029
+ alias_method :max_commands, :get_max_commands
2030
+
2031
+ # Returns the string that will be appended to the Redo menu item.
2032
+ # @return [Wx::String]
2033
+ def get_redo_accelerator; end
2034
+ alias_method :redo_accelerator, :get_redo_accelerator
2035
+
2036
+ # Returns the string that will be shown for the redo menu item.
2037
+ # @return [String]
2038
+ def get_redo_menu_label; end
2039
+ alias_method :redo_menu_label, :get_redo_menu_label
2040
+
2041
+ # Returns the string that will be appended to the Undo menu item.
2042
+ # @return [Wx::String]
2043
+ def get_undo_accelerator; end
2044
+ alias_method :undo_accelerator, :get_undo_accelerator
2045
+
2046
+ # Returns the string that will be shown for the undo menu item.
2047
+ # @return [String]
2048
+ def get_undo_menu_label; end
2049
+ alias_method :undo_menu_label, :get_undo_menu_label
2050
+
2051
+ # Initializes the command processor, setting the current command to the last in the list (if any), and updating the edit menu (if one has been specified).
2052
+ # @return [void]
2053
+ def initialize; end
2054
+
2055
+ # Returns a boolean value that indicates if changes have been made since the last save operation.
2056
+ #
2057
+ # This only works if {Wx::RTC::CommandProcessor#mark_as_saved} is called whenever the project is saved.
2058
+ # @return [Boolean]
2059
+ def is_dirty; end
2060
+ alias_method :dirty?, :is_dirty
2061
+
2062
+ # You must call this method whenever the project is saved if you plan to use {Wx::RTC::CommandProcessor#is_dirty}.
2063
+ # @return [void]
2064
+ def mark_as_saved; end
2065
+
2066
+ # Executes (redoes) the current command (the command that has just been undone if any).
2067
+ # @return [Boolean]
2068
+ def redo_; end
2069
+
2070
+ # Tells the command processor to update the Undo and Redo items on this menu as appropriate.
2071
+ #
2072
+ # Set this to nil if the menu is about to be destroyed and command operations may still be performed, or the command processor may try to access an invalid pointer.
2073
+ # @param menu [Wx::Menu]
2074
+ # @return [void]
2075
+ def set_edit_menu(menu) end
2076
+ alias_method :edit_menu=, :set_edit_menu
2077
+
2078
+ # Sets the menu labels according to the currently set menu and the current command state.
2079
+ # @return [void]
2080
+ def set_menu_strings; end
2081
+
2082
+ # Sets the string that will be appended to the Redo menu item.
2083
+ # @param accel [String]
2084
+ # @return [void]
2085
+ def set_redo_accelerator(accel) end
2086
+ alias_method :redo_accelerator=, :set_redo_accelerator
2087
+
2088
+ # Sets the string that will be appended to the Undo menu item.
2089
+ # @param accel [String]
2090
+ # @return [void]
2091
+ def set_undo_accelerator(accel) end
2092
+ alias_method :undo_accelerator=, :set_undo_accelerator
2093
+
2094
+ # Undoes the last command executed.
2095
+ # @return [Boolean]
2096
+ def undo; end
2097
+
2098
+ end # CommandProcessor
2099
+
2100
+
2101
+ end
2102
+
2103
+ end