wxruby3 0.9.5-x64-mingw-ucrt → 0.9.7-x64-mingw-ucrt

Sign up to get free protection for your applications and to get access to all the features.
Files changed (386) hide show
  1. checksums.yaml +4 -4
  2. data/.wxconfig +9 -8
  3. data/INSTALL.md +315 -78
  4. data/README.md +31 -20
  5. data/ext/wxbase32u_gcc_custom.dll +0 -0
  6. data/ext/wxbase32u_net_gcc_custom.dll +0 -0
  7. data/ext/wxbase32u_xml_gcc_custom.dll +0 -0
  8. data/ext/wxmsw32u_aui_gcc_custom.dll +0 -0
  9. data/ext/wxmsw32u_core_gcc_custom.dll +0 -0
  10. data/ext/wxmsw32u_gl_gcc_custom.dll +0 -0
  11. data/ext/wxmsw32u_html_gcc_custom.dll +0 -0
  12. data/ext/wxmsw32u_media_gcc_custom.dll +0 -0
  13. data/ext/wxmsw32u_propgrid_gcc_custom.dll +0 -0
  14. data/ext/wxmsw32u_qa_gcc_custom.dll +0 -0
  15. data/ext/wxmsw32u_ribbon_gcc_custom.dll +0 -0
  16. data/ext/wxmsw32u_richtext_gcc_custom.dll +0 -0
  17. data/ext/wxmsw32u_stc_gcc_custom.dll +0 -0
  18. data/ext/wxmsw32u_webview_gcc_custom.dll +0 -0
  19. data/ext/wxmsw32u_xrc_gcc_custom.dll +0 -0
  20. data/lib/wx/core/ext.rb +22 -3
  21. data/lib/wx/doc/gen/about_dialog_info.rb +1 -1
  22. data/lib/wx/doc/gen/accelerator.rb +1 -1
  23. data/lib/wx/doc/gen/accessible.rb +1 -1
  24. data/lib/wx/doc/gen/activity_indicator.rb +1 -1
  25. data/lib/wx/doc/gen/animation.rb +1 -1
  26. data/lib/wx/doc/gen/animation_ctrl.rb +1 -1
  27. data/lib/wx/doc/gen/any_button.rb +1 -1
  28. data/lib/wx/doc/gen/app.rb +1 -1
  29. data/lib/wx/doc/gen/app_traits.rb +1 -1
  30. data/lib/wx/doc/gen/art_provider.rb +1 -1
  31. data/lib/wx/doc/gen/aui/aui_dock_art.rb +430 -426
  32. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +34 -30
  33. data/lib/wx/doc/gen/aui/aui_manager.rb +352 -348
  34. data/lib/wx/doc/gen/aui/aui_manager_event.rb +107 -103
  35. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +157 -153
  36. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +42 -38
  37. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +109 -105
  38. data/lib/wx/doc/gen/aui/aui_notebook.rb +438 -434
  39. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +145 -141
  40. data/lib/wx/doc/gen/aui/aui_pane_info.rb +689 -685
  41. data/lib/wx/doc/gen/aui/aui_tab_art.rb +369 -365
  42. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +100 -96
  43. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +445 -441
  44. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +268 -264
  45. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +179 -175
  46. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +219 -215
  47. data/lib/wx/doc/gen/banner_window.rb +1 -1
  48. data/lib/wx/doc/gen/bitmap.rb +1 -1
  49. data/lib/wx/doc/gen/bitmap_button.rb +1 -1
  50. data/lib/wx/doc/gen/bitmap_combo_box.rb +1 -1
  51. data/lib/wx/doc/gen/book_ctrl_base.rb +1 -1
  52. data/lib/wx/doc/gen/book_ctrl_event.rb +1 -1
  53. data/lib/wx/doc/gen/box_sizer.rb +1 -1
  54. data/lib/wx/doc/gen/brush.rb +1 -1
  55. data/lib/wx/doc/gen/busy_info.rb +1 -1
  56. data/lib/wx/doc/gen/button.rb +1 -1
  57. data/lib/wx/doc/gen/calculate_layout_event.rb +1 -1
  58. data/lib/wx/doc/gen/calendar_ctrl.rb +1 -1
  59. data/lib/wx/doc/gen/calendar_date_attr.rb +1 -1
  60. data/lib/wx/doc/gen/calendar_event.rb +1 -1
  61. data/lib/wx/doc/gen/caret.rb +1 -1
  62. data/lib/wx/doc/gen/check_box.rb +1 -1
  63. data/lib/wx/doc/gen/check_list_box.rb +1 -1
  64. data/lib/wx/doc/gen/choice.rb +1 -1
  65. data/lib/wx/doc/gen/choicebook.rb +1 -1
  66. data/lib/wx/doc/gen/client_dc.rb +1 -1
  67. data/lib/wx/doc/gen/clipboard.rb +1 -1
  68. data/lib/wx/doc/gen/collapsible_pane.rb +1 -1
  69. data/lib/wx/doc/gen/collapsible_pane_event.rb +1 -1
  70. data/lib/wx/doc/gen/colour.rb +1 -1
  71. data/lib/wx/doc/gen/colour_dialog.rb +1 -1
  72. data/lib/wx/doc/gen/colour_picker_ctrl.rb +1 -1
  73. data/lib/wx/doc/gen/colour_picker_event.rb +1 -1
  74. data/lib/wx/doc/gen/combo_box.rb +1 -1
  75. data/lib/wx/doc/gen/combo_ctrl.rb +1 -1
  76. data/lib/wx/doc/gen/command_link_button.rb +1 -1
  77. data/lib/wx/doc/gen/config_base.rb +1 -1
  78. data/lib/wx/doc/gen/context_help_button.rb +1 -1
  79. data/lib/wx/doc/gen/control.rb +1 -1
  80. data/lib/wx/doc/gen/control_with_items.rb +1 -1
  81. data/lib/wx/doc/gen/core.rb +5 -5
  82. data/lib/wx/doc/gen/cursor.rb +1 -1
  83. data/lib/wx/doc/gen/data_format.rb +1 -1
  84. data/lib/wx/doc/gen/data_object.rb +1 -1
  85. data/lib/wx/doc/gen/data_object_simple_base.rb +1 -1
  86. data/lib/wx/doc/gen/date_event.rb +1 -1
  87. data/lib/wx/doc/gen/date_picker_ctrl.rb +1 -1
  88. data/lib/wx/doc/gen/dc.rb +1 -1
  89. data/lib/wx/doc/gen/defs.rb +1 -1
  90. data/lib/wx/doc/gen/dial_up_event.rb +1 -1
  91. data/lib/wx/doc/gen/dial_up_manager.rb +1 -1
  92. data/lib/wx/doc/gen/dialog.rb +1 -1
  93. data/lib/wx/doc/gen/dir_dialog.rb +1 -1
  94. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -1
  95. data/lib/wx/doc/gen/dir_picker_ctrl.rb +1 -1
  96. data/lib/wx/doc/gen/drag_drop.rb +1 -1
  97. data/lib/wx/doc/gen/drag_image.rb +1 -1
  98. data/lib/wx/doc/gen/editable_list_box.rb +1 -1
  99. data/lib/wx/doc/gen/event.rb +1 -1
  100. data/lib/wx/doc/gen/event_blocker.rb +1 -1
  101. data/lib/wx/doc/gen/event_filter.rb +1 -1
  102. data/lib/wx/doc/gen/events.rb +1 -1
  103. data/lib/wx/doc/gen/evt_handler.rb +1 -1
  104. data/lib/wx/doc/gen/ext_help_controller.rb +1 -1
  105. data/lib/wx/doc/gen/file_ctrl.rb +1 -1
  106. data/lib/wx/doc/gen/file_ctrl_event.rb +1 -1
  107. data/lib/wx/doc/gen/file_dialog.rb +1 -1
  108. data/lib/wx/doc/gen/file_dialog_custom_control.rb +1 -1
  109. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +1 -1
  110. data/lib/wx/doc/gen/file_dir_picker_event.rb +1 -1
  111. data/lib/wx/doc/gen/file_picker_ctrl.rb +1 -1
  112. data/lib/wx/doc/gen/file_system.rb +1 -1
  113. data/lib/wx/doc/gen/find_dialog_event.rb +1 -1
  114. data/lib/wx/doc/gen/find_replace_data.rb +1 -1
  115. data/lib/wx/doc/gen/find_replace_dialog.rb +1 -1
  116. data/lib/wx/doc/gen/flex_grid_sizer.rb +1 -1
  117. data/lib/wx/doc/gen/font.rb +1 -1
  118. data/lib/wx/doc/gen/font_data.rb +1 -1
  119. data/lib/wx/doc/gen/font_dialog.rb +1 -1
  120. data/lib/wx/doc/gen/font_picker_ctrl.rb +1 -1
  121. data/lib/wx/doc/gen/font_picker_event.rb +1 -1
  122. data/lib/wx/doc/gen/frame.rb +1 -1
  123. data/lib/wx/doc/gen/fs_file.rb +1 -1
  124. data/lib/wx/doc/gen/functions.rb +1 -1
  125. data/lib/wx/doc/gen/gauge.rb +1 -1
  126. data/lib/wx/doc/gen/gb_sizer_item.rb +1 -1
  127. data/lib/wx/doc/gen/gcdc.rb +1 -1
  128. data/lib/wx/doc/gen/gdi_common.rb +3 -3
  129. data/lib/wx/doc/gen/gdi_object.rb +1 -1
  130. data/lib/wx/doc/gen/generic_dir_ctrl.rb +1 -1
  131. data/lib/wx/doc/gen/graphics_context.rb +1 -1
  132. data/lib/wx/doc/gen/graphics_object.rb +1 -1
  133. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +28 -24
  134. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +251 -247
  135. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +25 -21
  136. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +27 -23
  137. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +38 -34
  138. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +25 -21
  139. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +35 -31
  140. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +28 -24
  141. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +34 -30
  142. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +30 -26
  143. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +183 -179
  144. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +29 -25
  145. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +33 -29
  146. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +34 -30
  147. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +67 -63
  148. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +34 -30
  149. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +25 -21
  150. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +93 -89
  151. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +25 -21
  152. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +38 -34
  153. data/lib/wx/doc/gen/grid/grid_ctrl.rb +2722 -2718
  154. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +82 -78
  155. data/lib/wx/doc/gen/grid/grid_event.rb +106 -102
  156. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +93 -89
  157. data/lib/wx/doc/gen/grid/grid_size_event.rb +70 -66
  158. data/lib/wx/doc/gen/grid/grid_string_table.rb +130 -126
  159. data/lib/wx/doc/gen/grid/grid_table_base.rb +303 -299
  160. data/lib/wx/doc/gen/grid/grid_table_message.rb +70 -66
  161. data/lib/wx/doc/gen/grid_bag_sizer.rb +1 -1
  162. data/lib/wx/doc/gen/grid_sizer.rb +1 -1
  163. data/lib/wx/doc/gen/gui_event_loop.rb +1 -1
  164. data/lib/wx/doc/gen/header_ctrl.rb +1 -1
  165. data/lib/wx/doc/gen/header_ctrl_event.rb +1 -1
  166. data/lib/wx/doc/gen/help_controller.rb +1 -1
  167. data/lib/wx/doc/gen/help_provider.rb +1 -1
  168. data/lib/wx/doc/gen/html/html_cell.rb +515 -511
  169. data/lib/wx/doc/gen/html/html_cell_event.rb +58 -54
  170. data/lib/wx/doc/gen/html/html_easy_printing.rb +171 -167
  171. data/lib/wx/doc/gen/html/html_help_controller.rb +292 -288
  172. data/lib/wx/doc/gen/html/html_help_data.rb +147 -143
  173. data/lib/wx/doc/gen/html/html_help_window.rb +232 -228
  174. data/lib/wx/doc/gen/html/html_link_event.rb +30 -26
  175. data/lib/wx/doc/gen/html/html_list_box.rb +301 -297
  176. data/lib/wx/doc/gen/html/html_printout.rb +94 -90
  177. data/lib/wx/doc/gen/html/html_window.rb +406 -402
  178. data/lib/wx/doc/gen/hyperlink_ctrl.rb +1 -1
  179. data/lib/wx/doc/gen/hyperlink_event.rb +1 -1
  180. data/lib/wx/doc/gen/icon.rb +1 -1
  181. data/lib/wx/doc/gen/icon_location.rb +1 -1
  182. data/lib/wx/doc/gen/image.rb +1 -1
  183. data/lib/wx/doc/gen/image_list.rb +1 -1
  184. data/lib/wx/doc/gen/info_bar.rb +1 -1
  185. data/lib/wx/doc/gen/keyboard_state.rb +1 -1
  186. data/lib/wx/doc/gen/list_box.rb +1 -1
  187. data/lib/wx/doc/gen/list_ctrl.rb +1 -1
  188. data/lib/wx/doc/gen/list_event.rb +1 -1
  189. data/lib/wx/doc/gen/listbook.rb +1 -1
  190. data/lib/wx/doc/gen/locale.rb +1 -1
  191. data/lib/wx/doc/gen/log.rb +1 -1
  192. data/lib/wx/doc/gen/mdi_client_window.rb +1 -1
  193. data/lib/wx/doc/gen/mdi_frame.rb +1 -1
  194. data/lib/wx/doc/gen/media_ctrl.rb +1 -1
  195. data/lib/wx/doc/gen/media_event.rb +1 -1
  196. data/lib/wx/doc/gen/memory_dc.rb +1 -1
  197. data/lib/wx/doc/gen/menu.rb +1 -1
  198. data/lib/wx/doc/gen/menu_bar.rb +1 -1
  199. data/lib/wx/doc/gen/menu_item.rb +1 -1
  200. data/lib/wx/doc/gen/message_dialog.rb +1 -1
  201. data/lib/wx/doc/gen/mini_frame.rb +1 -1
  202. data/lib/wx/doc/gen/mirror_dc.rb +1 -1
  203. data/lib/wx/doc/gen/mouse_state.rb +1 -1
  204. data/lib/wx/doc/gen/multi_choice_dialog.rb +1 -1
  205. data/lib/wx/doc/gen/non_owned_window.rb +1 -1
  206. data/lib/wx/doc/gen/notebook.rb +1 -1
  207. data/lib/wx/doc/gen/num_validator.rb +1 -1
  208. data/lib/wx/doc/gen/number_entry_dialog.rb +1 -1
  209. data/lib/wx/doc/gen/object.rb +1 -1
  210. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +1 -1
  211. data/lib/wx/doc/gen/paint_dc.rb +1 -1
  212. data/lib/wx/doc/gen/palette.rb +1 -1
  213. data/lib/wx/doc/gen/panel.rb +1 -1
  214. data/lib/wx/doc/gen/pen.rb +1 -1
  215. data/lib/wx/doc/gen/persistence_manager.rb +1 -1
  216. data/lib/wx/doc/gen/persistent_object.rb +1 -1
  217. data/lib/wx/doc/gen/persistent_window.rb +1 -1
  218. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +33 -29
  219. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +299 -295
  220. data/lib/wx/doc/gen/pg/pg_cell.rb +162 -158
  221. data/lib/wx/doc/gen/pg/pg_editor.rb +693 -689
  222. data/lib/wx/doc/gen/pg/pg_multi_button.rb +133 -129
  223. data/lib/wx/doc/gen/pg/pg_properties.rb +2662 -2658
  224. data/lib/wx/doc/gen/pg/pg_property.rb +1929 -1925
  225. data/lib/wx/doc/gen/pg/pg_validation_info.rb +275 -271
  226. data/lib/wx/doc/gen/pg/property_grid.rb +708 -704
  227. data/lib/wx/doc/gen/pg/property_grid_event.rb +168 -164
  228. data/lib/wx/doc/gen/pg/property_grid_interface.rb +1071 -1067
  229. data/lib/wx/doc/gen/pg/property_grid_manager.rb +386 -382
  230. data/lib/wx/doc/gen/pg/property_grid_page.rb +267 -263
  231. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +147 -143
  232. data/lib/wx/doc/gen/picker_base.rb +1 -1
  233. data/lib/wx/doc/gen/platform_info.rb +1 -1
  234. data/lib/wx/doc/gen/popup_window.rb +1 -1
  235. data/lib/wx/doc/gen/progress_dialog.rb +1 -1
  236. data/lib/wx/doc/gen/property_sheet_dialog.rb +1 -1
  237. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +32 -28
  238. data/lib/wx/doc/gen/prt/post_script_dc.rb +21 -17
  239. data/lib/wx/doc/gen/prt/preview_frame.rb +49 -45
  240. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +126 -122
  241. data/lib/wx/doc/gen/prt/print_data.rb +637 -633
  242. data/lib/wx/doc/gen/prt/print_dialog.rb +43 -39
  243. data/lib/wx/doc/gen/prt/printer.rb +484 -480
  244. data/lib/wx/doc/gen/prt/printer_dc.rb +26 -22
  245. data/lib/wx/doc/gen/query_layout_info_event.rb +1 -1
  246. data/lib/wx/doc/gen/radio_box.rb +1 -1
  247. data/lib/wx/doc/gen/radio_button.rb +1 -1
  248. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +1716 -1712
  249. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +239 -235
  250. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +34 -30
  251. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +439 -435
  252. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +52 -48
  253. data/lib/wx/doc/gen/rbn/ribbon_control.rb +116 -112
  254. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +205 -201
  255. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +44 -40
  256. data/lib/wx/doc/gen/rbn/ribbon_page.rb +129 -125
  257. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +229 -225
  258. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +34 -30
  259. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +329 -325
  260. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +31 -27
  261. data/lib/wx/doc/gen/rearrange_ctrl.rb +1 -1
  262. data/lib/wx/doc/gen/rearrange_list.rb +1 -1
  263. data/lib/wx/doc/gen/region.rb +1 -1
  264. data/lib/wx/doc/gen/region_iterator.rb +1 -1
  265. data/lib/wx/doc/gen/rtc/rich_text_box.rb +424 -420
  266. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +1148 -1144
  267. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +30 -26
  268. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +516 -512
  269. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +1991 -1987
  270. data/lib/wx/doc/gen/rtc/rich_text_event.rb +159 -155
  271. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +167 -163
  272. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +271 -267
  273. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +171 -167
  274. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +88 -84
  275. data/lib/wx/doc/gen/rtc/rich_text_image.rb +323 -319
  276. data/lib/wx/doc/gen/rtc/rich_text_object.rb +2819 -2815
  277. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +1187 -1183
  278. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +242 -238
  279. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +286 -282
  280. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +181 -177
  281. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +47 -43
  282. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +145 -141
  283. data/lib/wx/doc/gen/sash_event.rb +1 -1
  284. data/lib/wx/doc/gen/sash_layout_window.rb +1 -1
  285. data/lib/wx/doc/gen/sash_window.rb +1 -1
  286. data/lib/wx/doc/gen/scaled_dc.rb +1 -1
  287. data/lib/wx/doc/gen/screen_dc.rb +1 -1
  288. data/lib/wx/doc/gen/scroll_bar.rb +1 -1
  289. data/lib/wx/doc/gen/scrolled_canvas.rb +1 -1
  290. data/lib/wx/doc/gen/scrolled_control.rb +1 -1
  291. data/lib/wx/doc/gen/scrolled_window.rb +1 -1
  292. data/lib/wx/doc/gen/search_ctrl.rb +1 -1
  293. data/lib/wx/doc/gen/simplebook.rb +1 -1
  294. data/lib/wx/doc/gen/single_choice_dialog.rb +1 -1
  295. data/lib/wx/doc/gen/sizer.rb +1 -1
  296. data/lib/wx/doc/gen/sizer_item.rb +1 -1
  297. data/lib/wx/doc/gen/slider.rb +1 -1
  298. data/lib/wx/doc/gen/spin_button.rb +1 -1
  299. data/lib/wx/doc/gen/spin_ctrl.rb +1 -1
  300. data/lib/wx/doc/gen/spin_ctrl_double.rb +1 -1
  301. data/lib/wx/doc/gen/spin_double_event.rb +1 -1
  302. data/lib/wx/doc/gen/spin_event.rb +1 -1
  303. data/lib/wx/doc/gen/splash_screen.rb +1 -1
  304. data/lib/wx/doc/gen/splitter_event.rb +1 -1
  305. data/lib/wx/doc/gen/splitter_window.rb +1 -1
  306. data/lib/wx/doc/gen/static_bitmap.rb +1 -1
  307. data/lib/wx/doc/gen/static_box.rb +1 -1
  308. data/lib/wx/doc/gen/static_box_sizer.rb +1 -1
  309. data/lib/wx/doc/gen/static_line.rb +1 -1
  310. data/lib/wx/doc/gen/static_text.rb +1 -1
  311. data/lib/wx/doc/gen/status_bar.rb +1 -1
  312. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +4202 -4198
  313. data/lib/wx/doc/gen/stc/styled_text_event.rb +7511 -7507
  314. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +1 -1
  315. data/lib/wx/doc/gen/svg_file_dc.rb +1 -1
  316. data/lib/wx/doc/gen/system_options.rb +1 -1
  317. data/lib/wx/doc/gen/system_settings.rb +1 -1
  318. data/lib/wx/doc/gen/task_bar_button.rb +1 -1
  319. data/lib/wx/doc/gen/task_bar_icon.rb +1 -1
  320. data/lib/wx/doc/gen/task_bar_icon_event.rb +1 -1
  321. data/lib/wx/doc/gen/text_attr.rb +1 -1
  322. data/lib/wx/doc/gen/text_ctrl.rb +1 -1
  323. data/lib/wx/doc/gen/text_entry.rb +1 -1
  324. data/lib/wx/doc/gen/text_entry_dialog.rb +1 -1
  325. data/lib/wx/doc/gen/text_validator.rb +1 -1
  326. data/lib/wx/doc/gen/time_picker_ctrl.rb +1 -1
  327. data/lib/wx/doc/gen/timer.rb +1 -1
  328. data/lib/wx/doc/gen/timer_event.rb +1 -1
  329. data/lib/wx/doc/gen/tip_provider.rb +1 -1
  330. data/lib/wx/doc/gen/toggle_button.rb +1 -1
  331. data/lib/wx/doc/gen/tool_bar.rb +1 -1
  332. data/lib/wx/doc/gen/tool_tip.rb +1 -1
  333. data/lib/wx/doc/gen/toolbook.rb +1 -1
  334. data/lib/wx/doc/gen/top_level_window.rb +1 -1
  335. data/lib/wx/doc/gen/tree_ctrl.rb +1 -1
  336. data/lib/wx/doc/gen/tree_event.rb +1 -1
  337. data/lib/wx/doc/gen/treebook.rb +1 -1
  338. data/lib/wx/doc/gen/ui_action_simulator.rb +1 -1
  339. data/lib/wx/doc/gen/utils.rb +1 -1
  340. data/lib/wx/doc/gen/v_list_box.rb +1 -1
  341. data/lib/wx/doc/gen/v_scrolled_window.rb +1 -1
  342. data/lib/wx/doc/gen/validator.rb +1 -1
  343. data/lib/wx/doc/gen/variant.rb +1 -1
  344. data/lib/wx/doc/gen/window.rb +1 -1
  345. data/lib/wx/doc/gen/window_dc.rb +1 -1
  346. data/lib/wx/doc/gen/window_disabler.rb +1 -1
  347. data/lib/wx/doc/gen/with_images.rb +1 -1
  348. data/lib/wx/doc/gen/wizard.rb +1 -1
  349. data/lib/wx/doc/gen/wizard_event.rb +1 -1
  350. data/lib/wx/doc/gen/wizard_page.rb +1 -1
  351. data/lib/wx/doc/gen/wizard_page_simple.rb +1 -1
  352. data/lib/wx/doc/gen/wrap_sizer.rb +1 -1
  353. data/lib/wx/doc/gen/xml_node.rb +1 -1
  354. data/lib/wx/doc/gen/xml_resource.rb +1 -1
  355. data/lib/wx/rtc/ext/rich_text_ctrl.rb +5 -5
  356. data/lib/wx/version.rb +1 -1
  357. data/lib/wx/wxruby/base.rb +6 -4
  358. data/lib/wx/wxruby/cmd/sampler.rb +39 -29
  359. data/lib/wx/wxruby/cmd/setup.rb +122 -0
  360. data/lib/wx/wxruby/cmd/test.rb +56 -6
  361. data/lib/wxruby_aui.so +0 -0
  362. data/lib/wxruby_core.so +0 -0
  363. data/lib/wxruby_grid.so +0 -0
  364. data/lib/wxruby_html.so +0 -0
  365. data/lib/wxruby_pg.so +0 -0
  366. data/lib/wxruby_prt.so +0 -0
  367. data/lib/wxruby_rbn.so +0 -0
  368. data/lib/wxruby_rtc.so +0 -0
  369. data/lib/wxruby_stc.so +0 -0
  370. data/rakelib/install.rb +2 -0
  371. data/rakelib/lib/config/linux.rb +24 -2
  372. data/rakelib/lib/config/macosx.rb +16 -0
  373. data/rakelib/lib/config/mingw.rb +133 -9
  374. data/rakelib/lib/config/pkgman/arch.rb +53 -0
  375. data/rakelib/lib/config/pkgman/base.rb +169 -0
  376. data/rakelib/lib/config/pkgman/debian.rb +66 -0
  377. data/rakelib/lib/config/pkgman/macosx.rb +183 -0
  378. data/rakelib/lib/config/pkgman/rhel.rb +54 -0
  379. data/rakelib/lib/config/pkgman/suse.rb +54 -0
  380. data/rakelib/lib/config/unixish.rb +36 -19
  381. data/rakelib/lib/config.rb +254 -61
  382. data/rakelib/prepost.rake +9 -4
  383. data/rakelib/yard/templates/default/fulldoc/html/css/wxruby3.css +14 -0
  384. data/rakelib/yard/templates/default/fulldoc/html/setup.rb +5 -5
  385. data/rakelib/yard/yard/relative_markdown_links.rb +7 -1
  386. metadata +23 -4
@@ -6,1175 +6,1179 @@
6
6
 
7
7
  module Wx::RTC
8
8
 
9
- # This is a kind of paragraph layout box, used to represent the whole buffer.
10
- #
11
- # Category: Rich Text
12
- # @see Wx::RTC::RichTextParagraphLayoutBox
13
- # @see Wx::RTC::RichTextCtrl
14
- #
15
- #
16
- #
17
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
18
- # @wxrb_require USE_RICHTEXT
19
- class RichTextBuffer < RichTextParagraphLayoutBox
20
-
21
- # @overload initialize()
22
- # Default constructor.
23
- # @return [Wx::RTC::RichTextBuffer]
24
- # @overload initialize(obj)
25
- # Copy constructor.
26
- # @param obj [Wx::RTC::RichTextBuffer]
27
- # @return [Wx::RTC::RichTextBuffer]
28
- def initialize(*args) end
29
-
30
- # Sets style sheet, if any.
31
- #
32
- # This will allow the application to use named character and paragraph styles found in the style sheet.
33
- # Neither the buffer nor the control owns the style sheet so must be deleted by the application.
34
- # @param styleSheet [Wx::RTC::RichTextStyleSheet]
35
- # @return [void]
36
- def set_style_sheet(styleSheet) end
37
- alias_method :style_sheet=, :set_style_sheet
38
-
39
- # Returns the style sheet.
40
- # @return [Wx::RTC::RichTextStyleSheet]
41
- def get_style_sheet; end
42
- alias_method :style_sheet, :get_style_sheet
43
-
44
- # Sets the style sheet and sends a notification of the change.
45
- # @param sheet [Wx::RTC::RichTextStyleSheet]
46
- # @return [Boolean]
47
- def set_style_sheet_and_notify(sheet) end
48
- alias_method :style_sheet_and_notify=, :set_style_sheet_and_notify
49
-
50
- # Pushes the style sheet to the top of the style sheet stack.
51
- # @param styleSheet [Wx::RTC::RichTextStyleSheet]
52
- # @return [Boolean]
53
- def push_style_sheet(styleSheet) end
54
-
55
- # Pops the style sheet from the top of the style sheet stack.
56
- # @return [Wx::RTC::RichTextStyleSheet]
57
- def pop_style_sheet; end
58
-
59
- # Returns the table storing fonts, for quick access and font reuse.
60
- # @return [Wx::RTC::RichTextFontTable]
61
- def get_font_table; end
62
- alias_method :font_table, :get_font_table
63
-
64
- # Sets table storing fonts, for quick access and font reuse.
65
- # @param table [Wx::RTC::RichTextFontTable]
66
- # @return [void]
67
- def set_font_table(table) end
68
- alias_method :font_table=, :set_font_table
69
-
70
- # Sets the scale factor for displaying fonts, for example for more comfortable editing.
71
- # @param fontScale [Float]
72
- # @return [void]
73
- def set_font_scale(fontScale) end
74
- alias_method :font_scale=, :set_font_scale
75
-
76
- # Returns the scale factor for displaying fonts, for example for more comfortable editing.
77
- # @return [Float]
78
- def get_font_scale; end
79
- alias_method :font_scale, :get_font_scale
80
-
81
- # Sets the scale factor for displaying certain dimensions such as indentation and inter-paragraph spacing.
82
- #
83
- # This can be useful when editing in a small control where you still want legible text, but a minimum of wasted white space.
84
- # @param dimScale [Float]
85
- # @return [void]
86
- def set_dimension_scale(dimScale) end
87
- alias_method :dimension_scale=, :set_dimension_scale
88
-
89
- # Returns the scale factor for displaying certain dimensions such as indentation and inter-paragraph spacing.
90
- # @return [Float]
91
- def get_dimension_scale; end
92
- alias_method :dimension_scale, :get_dimension_scale
93
-
94
- # Initialisation.
95
- # @return [void]
96
- def init; end
97
-
98
- # Clears the buffer, adds an empty paragraph, and clears the command processor.
99
- # @return [void]
100
- def reset_and_clear_commands; end
101
-
102
- # @overload load_file(filename, type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)
103
- # Loads content from a stream or file.
104
- #
105
- # Not all handlers will implement file loading.
106
- # @param filename [String]
107
- # @param type [Wx::RichTextFileType]
108
- # @return [Boolean]
109
- # @overload load_file(stream, type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)
110
- # @param stream [Wx::InputStream]
111
- # @param type [Wx::RichTextFileType]
112
- # @return [Boolean]
113
- def load_file(*args) end
114
-
115
- # @overload save_file(filename, type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)
116
- # Saves content to a stream or file.
117
- #
118
- # Not all handlers will implement file saving.
119
- # @param filename [String]
120
- # @param type [Wx::RichTextFileType]
121
- # @return [Boolean]
122
- # @overload save_file(stream, type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)
123
- # @param stream [Wx::OutputStream]
124
- # @param type [Wx::RichTextFileType]
125
- # @return [Boolean]
126
- def save_file(*args) end
127
-
128
- # Sets the handler flags, controlling loading and saving.
129
- # @param flags [Integer]
130
- # @return [void]
131
- def set_handler_flags(flags) end
132
- alias_method :handler_flags=, :set_handler_flags
133
-
134
- # Gets the handler flags, controlling loading and saving.
135
- # @return [Integer]
136
- def get_handler_flags; end
137
- alias_method :handler_flags, :get_handler_flags
138
-
139
- # Convenience function to add a paragraph of text.
140
- # @param text [String]
141
- # @param paraStyle [Wx::RTC::RichTextAttr]
142
- # @return [Range]
143
- def add_paragraph(text, paraStyle=nil) end
144
-
145
- # Begin collapsing undo/redo commands.
146
- #
147
- # Note that this may not work properly if combining commands that delete or insert content, changing ranges for subsequent actions.
148
- # cmdName should be the name of the combined command that will appear next to Undo and Redo in the edit menu.
149
- # @param cmdName [String]
150
- # @return [Boolean]
151
- def begin_batch_undo(cmdName) end
152
-
153
- # End collapsing undo/redo commands.
154
- # @return [Boolean]
155
- def end_batch_undo; end
156
-
157
- # Returns true if we are collapsing commands.
158
- # @return [Boolean]
159
- def batching_undo; end
160
-
161
- # Begin suppressing undo/redo commands.
162
- #
163
- # The way undo is suppressed may be implemented differently by each command. If not dealt with by a command implementation, then it will be implemented automatically by not storing the command in the undo history when the action is submitted to the command processor.
164
- # @return [Boolean]
165
- def begin_suppress_undo; end
166
-
167
- # End suppressing undo/redo commands.
168
- # @return [Boolean]
169
- def end_suppress_undo; end
170
-
171
- # Are we suppressing undo??
172
- # @return [Boolean]
173
- def suppressing_undo; end
174
-
175
- # Copy the range to the clipboard.
176
- # @param range [Range]
177
- # @return [Boolean]
178
- def copy_to_clipboard(range) end
179
-
180
- # Paste the clipboard content to the buffer.
181
- # @param position [Integer]
182
- # @return [Boolean]
183
- def paste_from_clipboard(position) end
184
-
185
- # Returns true if we can paste from the clipboard.
186
- # @return [Boolean]
187
- def can_paste_from_clipboard; end
188
- alias_method :can_paste_from_clipboard?, :can_paste_from_clipboard
189
-
190
- # Begin using a style.
191
- # @param style [Wx::RTC::RichTextAttr]
192
- # @return [Boolean]
193
- def begin_style(style) end
194
-
195
- # End the style.
196
- # @return [Boolean]
197
- def end_style; end
198
-
199
- # End all styles.
200
- # @return [Boolean]
201
- def end_all_styles; end
202
-
203
- # Clears the style stack.
204
- # @return [void]
205
- def clear_style_stack; end
206
-
207
- # Returns the size of the style stack, for example to check correct nesting.
208
- # @return [Integer]
209
- def get_style_stack_size; end
210
- alias_method :style_stack_size, :get_style_stack_size
211
-
212
- # Begins using bold.
213
- # @return [Boolean]
214
- def begin_bold; end
215
-
216
- # Ends using bold.
217
- # @return [Boolean]
218
- def end_bold; end
219
-
220
- # Begins using italic.
221
- # @return [Boolean]
222
- def begin_italic; end
223
-
224
- # Ends using italic.
225
- # @return [Boolean]
226
- def end_italic; end
227
-
228
- # Begins using underline.
229
- # @return [Boolean]
230
- def begin_underline; end
231
-
232
- # Ends using underline.
233
- # @return [Boolean]
234
- def end_underline; end
235
-
236
- # Begins using point size.
237
- # @param pointSize [Integer]
238
- # @return [Boolean]
239
- def begin_font_size(pointSize) end
240
-
241
- # Ends using point size.
242
- # @return [Boolean]
243
- def end_font_size; end
244
-
245
- # Begins using this font.
246
- # @param font [Wx::Font,Wx::FontInfo]
247
- # @return [Boolean]
248
- def begin_font(font) end
249
-
250
- # Ends using a font.
251
- # @return [Boolean]
252
- def end_font; end
253
-
254
- # Begins using this colour.
255
- # @param colour [Wx::Colour,String,Symbol]
256
- # @return [Boolean]
257
- def begin_text_colour(colour) end
258
-
259
- # Ends using a colour.
260
- # @return [Boolean]
261
- def end_text_colour; end
262
-
263
- # Begins using alignment.
264
- # @param alignment [Wx::TextAttrAlignment]
265
- # @return [Boolean]
266
- def begin_alignment(alignment) end
267
-
268
- # Ends alignment.
269
- # @return [Boolean]
270
- def end_alignment; end
271
-
272
- # Begins using leftIndent for the left indent, and optionally leftSubIndent for the sub-indent.
273
- #
274
- # Both are expressed in tenths of a millimetre.
275
- # The sub-indent is an offset from the left 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 relative to the subsequent lines.
276
- # @param leftIndent [Integer]
277
- # @param leftSubIndent [Integer]
278
- # @return [Boolean]
279
- def begin_left_indent(leftIndent, leftSubIndent=0) end
280
-
281
- # Ends left indent.
282
- # @return [Boolean]
283
- def end_left_indent; end
284
-
285
- # Begins a right indent, specified in tenths of a millimetre.
286
- # @param rightIndent [Integer]
287
- # @return [Boolean]
288
- def begin_right_indent(rightIndent) end
289
-
290
- # Ends right indent.
291
- # @return [Boolean]
292
- def end_right_indent; end
293
-
294
- # Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing in tenths of a millimetre.
295
- # @param before [Integer]
296
- # @param after [Integer]
297
- # @return [Boolean]
298
- def begin_paragraph_spacing(before, after) end
299
-
300
- # Ends paragraph spacing.
301
- # @return [Boolean]
302
- def end_paragraph_spacing; end
303
-
304
- # Begins line spacing using the specified value.
305
- #
306
- # spacing is a multiple, where 10 means single-spacing, 15 means 1.5 spacing, and 20 means double spacing.
307
- # The {Wx::TextAttrLineSpacing} enumeration values are defined for convenience.
308
- # @param lineSpacing [Integer]
309
- # @return [Boolean]
310
- def begin_line_spacing(lineSpacing) end
311
-
312
- # Ends line spacing.
313
- # @return [Boolean]
314
- def end_line_spacing; end
315
-
316
- # Begins numbered bullet.
317
- #
318
- # This call will be needed for each item in the list, and the application should take care of incrementing the numbering.
319
- # bulletNumber is a number, usually starting with 1. leftIndent and leftSubIndent are values in tenths of a millimetre. bulletStyle is a bitlist of the following values:
320
- # {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.
321
- # @param bulletNumber [Integer]
322
- # @param leftIndent [Integer]
323
- # @param leftSubIndent [Integer]
324
- # @param bulletStyle [Integer]
325
- # @return [Boolean]
326
- def begin_numbered_bullet(bulletNumber, leftIndent, leftSubIndent, bulletStyle=(Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_ARABIC|Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_PERIOD)) end
327
-
328
- # Ends numbered bullet.
329
- # @return [Boolean]
330
- def end_numbered_bullet; end
331
-
332
- # Begins applying a symbol bullet, using a character from the current font.
333
- #
334
- # See {Wx::RTC::RichTextBuffer#begin_numbered_bullet} for an explanation of how indentation is used to render the bulleted paragraph.
335
- # @param symbol [String]
336
- # @param leftIndent [Integer]
337
- # @param leftSubIndent [Integer]
338
- # @param bulletStyle [Integer]
339
- # @return [Boolean]
340
- def begin_symbol_bullet(symbol, leftIndent, leftSubIndent, bulletStyle=Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_SYMBOL) end
341
-
342
- # Ends symbol bullet.
343
- # @return [Boolean]
344
- def end_symbol_bullet; end
345
-
346
- # Begins applying a standard bullet, using one of the standard bullet names (currently <code>standard/circle</code> or <code>standard/square</code>.
347
- #
348
- # See {Wx::RTC::RichTextBuffer#begin_numbered_bullet} for an explanation of how indentation is used to render the bulleted paragraph.
349
- # @param bulletName [String]
350
- # @param leftIndent [Integer]
351
- # @param leftSubIndent [Integer]
352
- # @param bulletStyle [Integer]
353
- # @return [Boolean]
354
- def begin_standard_bullet(bulletName, leftIndent, leftSubIndent, bulletStyle=Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_STANDARD) end
355
-
356
- # Ends standard bullet.
357
- # @return [Boolean]
358
- def end_standard_bullet; end
359
-
360
- # Begins named character style.
361
- # @param characterStyle [String]
362
- # @return [Boolean]
363
- def begin_character_style(characterStyle) end
364
-
365
- # Ends named character style.
366
- # @return [Boolean]
367
- def end_character_style; end
368
-
369
- # Begins named paragraph style.
370
- # @param paragraphStyle [String]
371
- # @return [Boolean]
372
- def begin_paragraph_style(paragraphStyle) end
373
-
374
- # Ends named character style.
375
- # @return [Boolean]
376
- def end_paragraph_style; end
377
-
378
- # Begins named list style.
379
- #
380
- # Optionally, you can also pass a level and a number.
381
- # @param listStyle [String]
382
- # @param level [Integer]
383
- # @param number [Integer]
384
- # @return [Boolean]
385
- def begin_list_style(listStyle, level=1, number=1) end
386
-
387
- # Ends named character style.
388
- # @return [Boolean]
389
- def end_list_style; end
390
-
391
- # Begins applying {Wx::TextAttrFlags::TEXT_ATTR_URL} to the content.
392
- #
393
- # 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.
394
- # @param url [String]
395
- # @param characterStyle [String]
396
- # @return [Boolean]
397
- def begin_url(url, characterStyle=('')) end
398
-
399
- # Ends URL.
400
- # @return [Boolean]
401
- def end_url; end
402
-
403
- # Adds an event handler.
404
- #
405
- # A buffer associated with a control has the control as the only event handler, but the application is free to add more if further notification is required. All handlers are notified of an event originating from the buffer, such as the replacement of a style sheet during loading.
406
- # The buffer never deletes any of the event handlers, unless {Wx::RTC::RichTextBuffer#remove_event_handler} is called with true as the second argument.
407
- # @param handler [Wx::EvtHandler]
408
- # @return [Boolean]
409
- def add_event_handler(handler) end
410
-
411
- # Removes an event handler from the buffer's list of handlers, deleting the object if deleteHandler is true.
412
- # @param handler [Wx::EvtHandler]
413
- # @param deleteHandler [Boolean]
414
- # @return [Boolean]
415
- def remove_event_handler(handler, deleteHandler=false) end
416
-
417
- # Clear event handlers.
418
- # @return [void]
419
- def clear_event_handlers; end
420
-
421
- # Send event to event handlers.
422
- #
423
- # If sendToAll is true, will send to all event handlers, otherwise will stop at the first successful one.
424
- # @param event [Wx::Event]
425
- # @param sendToAll [Boolean]
426
- # @return [Boolean]
427
- def send_event(event, sendToAll=true) end
428
-
429
- # Hit-testing: returns a flag indicating hit test details, plus information about position.
9
+ module Wx::RTC
10
+
11
+ # This is a kind of paragraph layout box, used to represent the whole buffer.
430
12
  #
431
- # contextObj is returned to specify what object position is relevant to, since otherwise there's an ambiguity. @ obj might not be a child of contextObj, since we may be referring to the container itself if we have no hit on a child - for example if we click outside an object.
432
- # The function puts the position in textPosition if one is found. pt is in logical units (a zero y position is at the beginning of the buffer).
433
- # One of the {Wx::RTC::RichTextHitTestFlags} values.
434
- # @param dc [Wx::DC]
435
- # @param context [Wx::RTC::RichTextDrawingContext]
436
- # @param pt [Array(Integer, Integer), Wx::Point]
437
- # @param textPosition [Integer]
438
- # @param flags [Integer]
439
- # @return [Array(Integer,Integer,Wx::RTC::RichTextObject,Wx::RTC::RichTextObject)]
440
- def hit_test(dc, context, pt, textPosition, flags=0) end
441
-
442
- # Copies the buffer.
443
- # @param obj [Wx::RTC::RichTextBuffer]
444
- # @return [void]
445
- def copy(obj) end
446
-
447
- # Clones the buffer.
448
- # @return [Wx::RTC::RichTextObject]
449
- def clone; end
450
-
451
- # Submits a command to insert paragraphs.
452
- # @param pos [Integer]
453
- # @param paragraphs [Wx::RTC::RichTextParagraphLayoutBox]
454
- # @param ctrl [Wx::RTC::RichTextCtrl]
455
- # @param flags [Integer]
456
- # @return [Boolean]
457
- def insert_paragraphs_with_undo(pos, paragraphs, ctrl, flags=0) end
458
-
459
- # Submits a command to insert the given text.
460
- # @param pos [Integer]
461
- # @param text [String]
462
- # @param ctrl [Wx::RTC::RichTextCtrl]
463
- # @param flags [Integer]
464
- # @return [Boolean]
465
- def insert_text_with_undo(pos, text, ctrl, flags=0) end
466
-
467
- # Submits a command to insert a newline.
468
- # @param pos [Integer]
469
- # @param ctrl [Wx::RTC::RichTextCtrl]
470
- # @param flags [Integer]
471
- # @return [Boolean]
472
- def insert_newline_with_undo(pos, ctrl, flags=0) end
473
-
474
- # Submits a command to insert the given image.
475
- # @param pos [Integer]
476
- # @param imageBlock [Wx::RTC::RichTextImageBlock]
477
- # @param ctrl [Wx::RTC::RichTextCtrl]
478
- # @param flags [Integer]
479
- # @param textAttr [Wx::RTC::RichTextAttr]
480
- # @return [Boolean]
481
- def insert_image_with_undo(pos, imageBlock, ctrl, flags=0, textAttr=(Wx::RichTextAttr.new())) end
482
-
483
- # Submits a command to insert an object.
484
- # @param pos [Integer]
485
- # @param object [Wx::RTC::RichTextObject]
486
- # @param ctrl [Wx::RTC::RichTextCtrl]
487
- # @param flags [Integer]
488
- # @return [Wx::RTC::RichTextObject]
489
- def insert_object_with_undo(pos, object, ctrl, flags) end
490
-
491
- # Submits a command to delete this range.
492
- # @param range [Range]
493
- # @param ctrl [Wx::RTC::RichTextCtrl]
494
- # @return [Boolean]
495
- def delete_range_with_undo(range, ctrl) end
496
-
497
- # Mark modified.
498
- # @param modify [Boolean]
499
- # @return [void]
500
- def modify(modify=true) end
501
-
502
- # Returns true if the buffer was modified.
503
- # @return [Boolean]
504
- def is_modified; end
505
- alias_method :modified?, :is_modified
506
-
507
- # @overload dump()
508
- # Dumps contents of buffer for debugging purposes.
509
- # @return [void]
510
- # @overload dump(stream)
511
- # Dump object data to the given output stream for debugging.
512
- # @param stream [Wx::TextOutputStream]
513
- # @return [void]
514
- def dump(*args) end
515
-
516
- # Returns the scale factor for calculating dimensions.
517
- # @return [Float]
518
- def get_scale; end
519
- alias_method :scale, :get_scale
520
-
521
- # Sets the scale factor for calculating dimensions.
522
- # @param scale [Float]
523
- # @return [void]
524
- def set_scale(scale) end
525
- alias_method :scale=, :set_scale
526
-
527
- # Adds a file handler to the end.
528
- # @param handler [Wx::RTC::RichTextFileHandler]
529
- # @return [void]
530
- def self.add_handler(handler) end
531
-
532
- # Inserts a file handler at the front.
533
- # @param handler [Wx::RTC::RichTextFileHandler]
534
- # @return [void]
535
- def self.insert_handler(handler) end
536
-
537
- # Removes a file handler.
538
- # @param name [String]
539
- # @return [Boolean]
540
- def self.remove_handler(name) end
541
-
542
- # @overload self.find_handler(name)
543
- # Finds a file handler by name.
544
- # @param name [String]
545
- # @return [Wx::RTC::RichTextFileHandler]
546
- # @overload self.find_handler(extension, imageType)
547
- # Finds a file handler by extension and type.
548
- # @param extension [String]
549
- # @param imageType [Wx::RichTextFileType]
550
- # @return [Wx::RTC::RichTextFileHandler]
551
- # @overload self.find_handler(imageType)
552
- # Finds a handler by type.
553
- # @param imageType [Wx::RichTextFileType]
554
- # @return [Wx::RTC::RichTextFileHandler]
555
- def self.find_handler(*args) end
556
-
557
- # Finds a handler by filename or, if supplied, type.
558
- # @param filename [String]
559
- # @param imageType [Wx::RichTextFileType]
560
- # @return [Wx::RTC::RichTextFileHandler]
561
- def self.find_handler_filename_or_type(filename, imageType) end
562
-
563
- # Gets a wildcard incorporating all visible handlers.
13
+ # Category: Rich Text
14
+ # @see Wx::RTC::RichTextParagraphLayoutBox
15
+ # @see Wx::RTC::RichTextCtrl
564
16
  #
565
- # If types is present, it will be filled with the file type corresponding to each filter. This can be used to determine the type to pass to LoadFile given a selected filter.
566
- # @param combine [Boolean]
567
- # @param save [Boolean]
568
- # @param types [Array,nil]
569
- # @return [String]
570
- def self.get_ext_wildcard(combine=false, save=false, types=nil) end
571
-
572
- # Clean up file handlers.
573
- # @return [void]
574
- def self.clean_up_handlers; end
575
-
576
- # Initialise the standard file handlers.
577
17
  #
578
- # Currently, only the plain text loading/saving handler is initialised by default.
579
- # @return [void]
580
- def self.init_standard_handlers; end
581
-
582
- # Adds a drawing handler to the end.
583
- # @param handler [Wx::RTC::RichTextDrawingHandler]
584
- # @return [void]
585
- def self.add_drawing_handler(handler) end
586
-
587
- # Inserts a drawing handler at the front.
588
- # @param handler [Wx::RTC::RichTextDrawingHandler]
589
- # @return [void]
590
- def self.insert_drawing_handler(handler) end
591
-
592
- # Removes a drawing handler.
593
- # @param name [String]
594
- # @return [Boolean]
595
- def self.remove_drawing_handler(name) end
596
-
597
- # Finds a drawing handler by name.
598
- # @param name [String]
599
- # @return [Wx::RTC::RichTextDrawingHandler]
600
- def self.find_drawing_handler(name) end
601
-
602
- # Clean up drawing handlers.
603
- # @return [void]
604
- def self.clean_up_drawing_handlers; end
605
-
606
- # Adds a field type.
607
18
  #
19
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
20
+ # @wxrb_require USE_RICHTEXT
21
+ class RichTextBuffer < RichTextParagraphLayoutBox
22
+
23
+ # @overload initialize()
24
+ # Default constructor.
25
+ # @return [Wx::RTC::RichTextBuffer]
26
+ # @overload initialize(obj)
27
+ # Copy constructor.
28
+ # @param obj [Wx::RTC::RichTextBuffer]
29
+ # @return [Wx::RTC::RichTextBuffer]
30
+ def initialize(*args) end
31
+
32
+ # Sets style sheet, if any.
33
+ #
34
+ # This will allow the application to use named character and paragraph styles found in the style sheet.
35
+ # Neither the buffer nor the control owns the style sheet so must be deleted by the application.
36
+ # @param styleSheet [Wx::RTC::RichTextStyleSheet]
37
+ # @return [void]
38
+ def set_style_sheet(styleSheet) end
39
+ alias_method :style_sheet=, :set_style_sheet
40
+
41
+ # Returns the style sheet.
42
+ # @return [Wx::RTC::RichTextStyleSheet]
43
+ def get_style_sheet; end
44
+ alias_method :style_sheet, :get_style_sheet
45
+
46
+ # Sets the style sheet and sends a notification of the change.
47
+ # @param sheet [Wx::RTC::RichTextStyleSheet]
48
+ # @return [Boolean]
49
+ def set_style_sheet_and_notify(sheet) end
50
+ alias_method :style_sheet_and_notify=, :set_style_sheet_and_notify
51
+
52
+ # Pushes the style sheet to the top of the style sheet stack.
53
+ # @param styleSheet [Wx::RTC::RichTextStyleSheet]
54
+ # @return [Boolean]
55
+ def push_style_sheet(styleSheet) end
56
+
57
+ # Pops the style sheet from the top of the style sheet stack.
58
+ # @return [Wx::RTC::RichTextStyleSheet]
59
+ def pop_style_sheet; end
60
+
61
+ # Returns the table storing fonts, for quick access and font reuse.
62
+ # @return [Wx::RTC::RichTextFontTable]
63
+ def get_font_table; end
64
+ alias_method :font_table, :get_font_table
65
+
66
+ # Sets table storing fonts, for quick access and font reuse.
67
+ # @param table [Wx::RTC::RichTextFontTable]
68
+ # @return [void]
69
+ def set_font_table(table) end
70
+ alias_method :font_table=, :set_font_table
71
+
72
+ # Sets the scale factor for displaying fonts, for example for more comfortable editing.
73
+ # @param fontScale [Float]
74
+ # @return [void]
75
+ def set_font_scale(fontScale) end
76
+ alias_method :font_scale=, :set_font_scale
77
+
78
+ # Returns the scale factor for displaying fonts, for example for more comfortable editing.
79
+ # @return [Float]
80
+ def get_font_scale; end
81
+ alias_method :font_scale, :get_font_scale
82
+
83
+ # Sets the scale factor for displaying certain dimensions such as indentation and inter-paragraph spacing.
84
+ #
85
+ # This can be useful when editing in a small control where you still want legible text, but a minimum of wasted white space.
86
+ # @param dimScale [Float]
87
+ # @return [void]
88
+ def set_dimension_scale(dimScale) end
89
+ alias_method :dimension_scale=, :set_dimension_scale
90
+
91
+ # Returns the scale factor for displaying certain dimensions such as indentation and inter-paragraph spacing.
92
+ # @return [Float]
93
+ def get_dimension_scale; end
94
+ alias_method :dimension_scale, :get_dimension_scale
95
+
96
+ # Initialisation.
97
+ # @return [void]
98
+ def init; end
99
+
100
+ # Clears the buffer, adds an empty paragraph, and clears the command processor.
101
+ # @return [void]
102
+ def reset_and_clear_commands; end
103
+
104
+ # @overload load_file(filename, type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)
105
+ # Loads content from a stream or file.
106
+ #
107
+ # Not all handlers will implement file loading.
108
+ # @param filename [String]
109
+ # @param type [Wx::RichTextFileType]
110
+ # @return [Boolean]
111
+ # @overload load_file(stream, type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)
112
+ # @param stream [Wx::InputStream]
113
+ # @param type [Wx::RichTextFileType]
114
+ # @return [Boolean]
115
+ def load_file(*args) end
116
+
117
+ # @overload save_file(filename, type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)
118
+ # Saves content to a stream or file.
119
+ #
120
+ # Not all handlers will implement file saving.
121
+ # @param filename [String]
122
+ # @param type [Wx::RichTextFileType]
123
+ # @return [Boolean]
124
+ # @overload save_file(stream, type=Wx::RTC::RichTextFileType::RICHTEXT_TYPE_ANY)
125
+ # @param stream [Wx::OutputStream]
126
+ # @param type [Wx::RichTextFileType]
127
+ # @return [Boolean]
128
+ def save_file(*args) end
129
+
130
+ # Sets the handler flags, controlling loading and saving.
131
+ # @param flags [Integer]
132
+ # @return [void]
133
+ def set_handler_flags(flags) end
134
+ alias_method :handler_flags=, :set_handler_flags
135
+
136
+ # Gets the handler flags, controlling loading and saving.
137
+ # @return [Integer]
138
+ def get_handler_flags; end
139
+ alias_method :handler_flags, :get_handler_flags
140
+
141
+ # Convenience function to add a paragraph of text.
142
+ # @param text [String]
143
+ # @param paraStyle [Wx::RTC::RichTextAttr]
144
+ # @return [Range]
145
+ def add_paragraph(text, paraStyle=nil) end
146
+
147
+ # Begin collapsing undo/redo commands.
148
+ #
149
+ # Note that this may not work properly if combining commands that delete or insert content, changing ranges for subsequent actions.
150
+ # cmdName should be the name of the combined command that will appear next to Undo and Redo in the edit menu.
151
+ # @param cmdName [String]
152
+ # @return [Boolean]
153
+ def begin_batch_undo(cmdName) end
154
+
155
+ # End collapsing undo/redo commands.
156
+ # @return [Boolean]
157
+ def end_batch_undo; end
158
+
159
+ # Returns true if we are collapsing commands.
160
+ # @return [Boolean]
161
+ def batching_undo; end
162
+
163
+ # Begin suppressing undo/redo commands.
164
+ #
165
+ # The way undo is suppressed may be implemented differently by each command. If not dealt with by a command implementation, then it will be implemented automatically by not storing the command in the undo history when the action is submitted to the command processor.
166
+ # @return [Boolean]
167
+ def begin_suppress_undo; end
168
+
169
+ # End suppressing undo/redo commands.
170
+ # @return [Boolean]
171
+ def end_suppress_undo; end
172
+
173
+ # Are we suppressing undo??
174
+ # @return [Boolean]
175
+ def suppressing_undo; end
176
+
177
+ # Copy the range to the clipboard.
178
+ # @param range [Range]
179
+ # @return [Boolean]
180
+ def copy_to_clipboard(range) end
181
+
182
+ # Paste the clipboard content to the buffer.
183
+ # @param position [Integer]
184
+ # @return [Boolean]
185
+ def paste_from_clipboard(position) end
186
+
187
+ # Returns true if we can paste from the clipboard.
188
+ # @return [Boolean]
189
+ def can_paste_from_clipboard; end
190
+ alias_method :can_paste_from_clipboard?, :can_paste_from_clipboard
191
+
192
+ # Begin using a style.
193
+ # @param style [Wx::RTC::RichTextAttr]
194
+ # @return [Boolean]
195
+ def begin_style(style) end
196
+
197
+ # End the style.
198
+ # @return [Boolean]
199
+ def end_style; end
200
+
201
+ # End all styles.
202
+ # @return [Boolean]
203
+ def end_all_styles; end
204
+
205
+ # Clears the style stack.
206
+ # @return [void]
207
+ def clear_style_stack; end
208
+
209
+ # Returns the size of the style stack, for example to check correct nesting.
210
+ # @return [Integer]
211
+ def get_style_stack_size; end
212
+ alias_method :style_stack_size, :get_style_stack_size
213
+
214
+ # Begins using bold.
215
+ # @return [Boolean]
216
+ def begin_bold; end
217
+
218
+ # Ends using bold.
219
+ # @return [Boolean]
220
+ def end_bold; end
221
+
222
+ # Begins using italic.
223
+ # @return [Boolean]
224
+ def begin_italic; end
225
+
226
+ # Ends using italic.
227
+ # @return [Boolean]
228
+ def end_italic; end
229
+
230
+ # Begins using underline.
231
+ # @return [Boolean]
232
+ def begin_underline; end
233
+
234
+ # Ends using underline.
235
+ # @return [Boolean]
236
+ def end_underline; end
237
+
238
+ # Begins using point size.
239
+ # @param pointSize [Integer]
240
+ # @return [Boolean]
241
+ def begin_font_size(pointSize) end
242
+
243
+ # Ends using point size.
244
+ # @return [Boolean]
245
+ def end_font_size; end
246
+
247
+ # Begins using this font.
248
+ # @param font [Wx::Font,Wx::FontInfo]
249
+ # @return [Boolean]
250
+ def begin_font(font) end
251
+
252
+ # Ends using a font.
253
+ # @return [Boolean]
254
+ def end_font; end
255
+
256
+ # Begins using this colour.
257
+ # @param colour [Wx::Colour,String,Symbol]
258
+ # @return [Boolean]
259
+ def begin_text_colour(colour) end
260
+
261
+ # Ends using a colour.
262
+ # @return [Boolean]
263
+ def end_text_colour; end
264
+
265
+ # Begins using alignment.
266
+ # @param alignment [Wx::TextAttrAlignment]
267
+ # @return [Boolean]
268
+ def begin_alignment(alignment) end
269
+
270
+ # Ends alignment.
271
+ # @return [Boolean]
272
+ def end_alignment; end
273
+
274
+ # Begins using leftIndent for the left indent, and optionally leftSubIndent for the sub-indent.
275
+ #
276
+ # Both are expressed in tenths of a millimetre.
277
+ # The sub-indent is an offset from the left 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 relative to the subsequent lines.
278
+ # @param leftIndent [Integer]
279
+ # @param leftSubIndent [Integer]
280
+ # @return [Boolean]
281
+ def begin_left_indent(leftIndent, leftSubIndent=0) end
282
+
283
+ # Ends left indent.
284
+ # @return [Boolean]
285
+ def end_left_indent; end
286
+
287
+ # Begins a right indent, specified in tenths of a millimetre.
288
+ # @param rightIndent [Integer]
289
+ # @return [Boolean]
290
+ def begin_right_indent(rightIndent) end
291
+
292
+ # Ends right indent.
293
+ # @return [Boolean]
294
+ def end_right_indent; end
295
+
296
+ # Begins paragraph spacing; pass the before-paragraph and after-paragraph spacing in tenths of a millimetre.
297
+ # @param before [Integer]
298
+ # @param after [Integer]
299
+ # @return [Boolean]
300
+ def begin_paragraph_spacing(before, after) end
301
+
302
+ # Ends paragraph spacing.
303
+ # @return [Boolean]
304
+ def end_paragraph_spacing; end
305
+
306
+ # Begins line spacing using the specified value.
307
+ #
308
+ # spacing is a multiple, where 10 means single-spacing, 15 means 1.5 spacing, and 20 means double spacing.
309
+ # The {Wx::TextAttrLineSpacing} enumeration values are defined for convenience.
310
+ # @param lineSpacing [Integer]
311
+ # @return [Boolean]
312
+ def begin_line_spacing(lineSpacing) end
313
+
314
+ # Ends line spacing.
315
+ # @return [Boolean]
316
+ def end_line_spacing; end
317
+
318
+ # Begins numbered bullet.
319
+ #
320
+ # This call will be needed for each item in the list, and the application should take care of incrementing the numbering.
321
+ # bulletNumber is a number, usually starting with 1. leftIndent and leftSubIndent are values in tenths of a millimetre. bulletStyle is a bitlist of the following values:
322
+ # {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.
323
+ # @param bulletNumber [Integer]
324
+ # @param leftIndent [Integer]
325
+ # @param leftSubIndent [Integer]
326
+ # @param bulletStyle [Integer]
327
+ # @return [Boolean]
328
+ def begin_numbered_bullet(bulletNumber, leftIndent, leftSubIndent, bulletStyle=(Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_ARABIC|Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_PERIOD)) end
329
+
330
+ # Ends numbered bullet.
331
+ # @return [Boolean]
332
+ def end_numbered_bullet; end
333
+
334
+ # Begins applying a symbol bullet, using a character from the current font.
335
+ #
336
+ # See {Wx::RTC::RichTextBuffer#begin_numbered_bullet} for an explanation of how indentation is used to render the bulleted paragraph.
337
+ # @param symbol [String]
338
+ # @param leftIndent [Integer]
339
+ # @param leftSubIndent [Integer]
340
+ # @param bulletStyle [Integer]
341
+ # @return [Boolean]
342
+ def begin_symbol_bullet(symbol, leftIndent, leftSubIndent, bulletStyle=Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_SYMBOL) end
343
+
344
+ # Ends symbol bullet.
345
+ # @return [Boolean]
346
+ def end_symbol_bullet; end
347
+
348
+ # Begins applying a standard bullet, using one of the standard bullet names (currently <code>standard/circle</code> or <code>standard/square</code>.
349
+ #
350
+ # See {Wx::RTC::RichTextBuffer#begin_numbered_bullet} for an explanation of how indentation is used to render the bulleted paragraph.
351
+ # @param bulletName [String]
352
+ # @param leftIndent [Integer]
353
+ # @param leftSubIndent [Integer]
354
+ # @param bulletStyle [Integer]
355
+ # @return [Boolean]
356
+ def begin_standard_bullet(bulletName, leftIndent, leftSubIndent, bulletStyle=Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_STANDARD) end
357
+
358
+ # Ends standard bullet.
359
+ # @return [Boolean]
360
+ def end_standard_bullet; end
361
+
362
+ # Begins named character style.
363
+ # @param characterStyle [String]
364
+ # @return [Boolean]
365
+ def begin_character_style(characterStyle) end
366
+
367
+ # Ends named character style.
368
+ # @return [Boolean]
369
+ def end_character_style; end
370
+
371
+ # Begins named paragraph style.
372
+ # @param paragraphStyle [String]
373
+ # @return [Boolean]
374
+ def begin_paragraph_style(paragraphStyle) end
375
+
376
+ # Ends named character style.
377
+ # @return [Boolean]
378
+ def end_paragraph_style; end
379
+
380
+ # Begins named list style.
381
+ #
382
+ # Optionally, you can also pass a level and a number.
383
+ # @param listStyle [String]
384
+ # @param level [Integer]
385
+ # @param number [Integer]
386
+ # @return [Boolean]
387
+ def begin_list_style(listStyle, level=1, number=1) end
388
+
389
+ # Ends named character style.
390
+ # @return [Boolean]
391
+ def end_list_style; end
392
+
393
+ # Begins applying {Wx::TextAttrFlags::TEXT_ATTR_URL} to the content.
394
+ #
395
+ # 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.
396
+ # @param url [String]
397
+ # @param characterStyle [String]
398
+ # @return [Boolean]
399
+ def begin_url(url, characterStyle=('')) end
400
+
401
+ # Ends URL.
402
+ # @return [Boolean]
403
+ def end_url; end
404
+
405
+ # Adds an event handler.
406
+ #
407
+ # A buffer associated with a control has the control as the only event handler, but the application is free to add more if further notification is required. All handlers are notified of an event originating from the buffer, such as the replacement of a style sheet during loading.
408
+ # The buffer never deletes any of the event handlers, unless {Wx::RTC::RichTextBuffer#remove_event_handler} is called with true as the second argument.
409
+ # @param handler [Wx::EvtHandler]
410
+ # @return [Boolean]
411
+ def add_event_handler(handler) end
412
+
413
+ # Removes an event handler from the buffer's list of handlers, deleting the object if deleteHandler is true.
414
+ # @param handler [Wx::EvtHandler]
415
+ # @param deleteHandler [Boolean]
416
+ # @return [Boolean]
417
+ def remove_event_handler(handler, deleteHandler=false) end
418
+
419
+ # Clear event handlers.
420
+ # @return [void]
421
+ def clear_event_handlers; end
422
+
423
+ # Send event to event handlers.
424
+ #
425
+ # If sendToAll is true, will send to all event handlers, otherwise will stop at the first successful one.
426
+ # @param event [Wx::Event]
427
+ # @param sendToAll [Boolean]
428
+ # @return [Boolean]
429
+ def send_event(event, sendToAll=true) end
430
+
431
+ # Hit-testing: returns a flag indicating hit test details, plus information about position.
432
+ #
433
+ # contextObj is returned to specify what object position is relevant to, since otherwise there's an ambiguity. @ obj might not be a child of contextObj, since we may be referring to the container itself if we have no hit on a child - for example if we click outside an object.
434
+ # The function puts the position in textPosition if one is found. pt is in logical units (a zero y position is at the beginning of the buffer).
435
+ # One of the {Wx::RTC::RichTextHitTestFlags} values.
436
+ # @param dc [Wx::DC]
437
+ # @param context [Wx::RTC::RichTextDrawingContext]
438
+ # @param pt [Array(Integer, Integer), Wx::Point]
439
+ # @param textPosition [Integer]
440
+ # @param flags [Integer]
441
+ # @return [Array(Integer,Integer,Wx::RTC::RichTextObject,Wx::RTC::RichTextObject)]
442
+ def hit_test(dc, context, pt, textPosition, flags=0) end
443
+
444
+ # Copies the buffer.
445
+ # @param obj [Wx::RTC::RichTextBuffer]
446
+ # @return [void]
447
+ def copy(obj) end
448
+
449
+ # Clones the buffer.
450
+ # @return [Wx::RTC::RichTextObject]
451
+ def clone; end
452
+
453
+ # Submits a command to insert paragraphs.
454
+ # @param pos [Integer]
455
+ # @param paragraphs [Wx::RTC::RichTextParagraphLayoutBox]
456
+ # @param ctrl [Wx::RTC::RichTextCtrl]
457
+ # @param flags [Integer]
458
+ # @return [Boolean]
459
+ def insert_paragraphs_with_undo(pos, paragraphs, ctrl, flags=0) end
460
+
461
+ # Submits a command to insert the given text.
462
+ # @param pos [Integer]
463
+ # @param text [String]
464
+ # @param ctrl [Wx::RTC::RichTextCtrl]
465
+ # @param flags [Integer]
466
+ # @return [Boolean]
467
+ def insert_text_with_undo(pos, text, ctrl, flags=0) end
468
+
469
+ # Submits a command to insert a newline.
470
+ # @param pos [Integer]
471
+ # @param ctrl [Wx::RTC::RichTextCtrl]
472
+ # @param flags [Integer]
473
+ # @return [Boolean]
474
+ def insert_newline_with_undo(pos, ctrl, flags=0) end
475
+
476
+ # Submits a command to insert the given image.
477
+ # @param pos [Integer]
478
+ # @param imageBlock [Wx::RTC::RichTextImageBlock]
479
+ # @param ctrl [Wx::RTC::RichTextCtrl]
480
+ # @param flags [Integer]
481
+ # @param textAttr [Wx::RTC::RichTextAttr]
482
+ # @return [Boolean]
483
+ def insert_image_with_undo(pos, imageBlock, ctrl, flags=0, textAttr=(Wx::RichTextAttr.new())) end
484
+
485
+ # Submits a command to insert an object.
486
+ # @param pos [Integer]
487
+ # @param object [Wx::RTC::RichTextObject]
488
+ # @param ctrl [Wx::RTC::RichTextCtrl]
489
+ # @param flags [Integer]
490
+ # @return [Wx::RTC::RichTextObject]
491
+ def insert_object_with_undo(pos, object, ctrl, flags) end
492
+
493
+ # Submits a command to delete this range.
494
+ # @param range [Range]
495
+ # @param ctrl [Wx::RTC::RichTextCtrl]
496
+ # @return [Boolean]
497
+ def delete_range_with_undo(range, ctrl) end
498
+
499
+ # Mark modified.
500
+ # @param modify [Boolean]
501
+ # @return [void]
502
+ def modify(modify=true) end
503
+
504
+ # Returns true if the buffer was modified.
505
+ # @return [Boolean]
506
+ def is_modified; end
507
+ alias_method :modified?, :is_modified
508
+
509
+ # @overload dump()
510
+ # Dumps contents of buffer for debugging purposes.
511
+ # @return [void]
512
+ # @overload dump(stream)
513
+ # Dump object data to the given output stream for debugging.
514
+ # @param stream [Wx::TextOutputStream]
515
+ # @return [void]
516
+ def dump(*args) end
517
+
518
+ # Returns the scale factor for calculating dimensions.
519
+ # @return [Float]
520
+ def get_scale; end
521
+ alias_method :scale, :get_scale
522
+
523
+ # Sets the scale factor for calculating dimensions.
524
+ # @param scale [Float]
525
+ # @return [void]
526
+ def set_scale(scale) end
527
+ alias_method :scale=, :set_scale
528
+
529
+ # Adds a file handler to the end.
530
+ # @param handler [Wx::RTC::RichTextFileHandler]
531
+ # @return [void]
532
+ def self.add_handler(handler) end
533
+
534
+ # Inserts a file handler at the front.
535
+ # @param handler [Wx::RTC::RichTextFileHandler]
536
+ # @return [void]
537
+ def self.insert_handler(handler) end
538
+
539
+ # Removes a file handler.
540
+ # @param name [String]
541
+ # @return [Boolean]
542
+ def self.remove_handler(name) end
543
+
544
+ # @overload self.find_handler(name)
545
+ # Finds a file handler by name.
546
+ # @param name [String]
547
+ # @return [Wx::RTC::RichTextFileHandler]
548
+ # @overload self.find_handler(extension, imageType)
549
+ # Finds a file handler by extension and type.
550
+ # @param extension [String]
551
+ # @param imageType [Wx::RichTextFileType]
552
+ # @return [Wx::RTC::RichTextFileHandler]
553
+ # @overload self.find_handler(imageType)
554
+ # Finds a handler by type.
555
+ # @param imageType [Wx::RichTextFileType]
556
+ # @return [Wx::RTC::RichTextFileHandler]
557
+ def self.find_handler(*args) end
558
+
559
+ # Finds a handler by filename or, if supplied, type.
560
+ # @param filename [String]
561
+ # @param imageType [Wx::RichTextFileType]
562
+ # @return [Wx::RTC::RichTextFileHandler]
563
+ def self.find_handler_filename_or_type(filename, imageType) end
564
+
565
+ # Gets a wildcard incorporating all visible handlers.
566
+ #
567
+ # If types is present, it will be filled with the file type corresponding to each filter. This can be used to determine the type to pass to LoadFile given a selected filter.
568
+ # @param combine [Boolean]
569
+ # @param save [Boolean]
570
+ # @param types [Array,nil]
571
+ # @return [String]
572
+ def self.get_ext_wildcard(combine=false, save=false, types=nil) end
573
+
574
+ # Clean up file handlers.
575
+ # @return [void]
576
+ def self.clean_up_handlers; end
577
+
578
+ # Initialise the standard file handlers.
579
+ #
580
+ # Currently, only the plain text loading/saving handler is initialised by default.
581
+ # @return [void]
582
+ def self.init_standard_handlers; end
583
+
584
+ # Adds a drawing handler to the end.
585
+ # @param handler [Wx::RTC::RichTextDrawingHandler]
586
+ # @return [void]
587
+ def self.add_drawing_handler(handler) end
588
+
589
+ # Inserts a drawing handler at the front.
590
+ # @param handler [Wx::RTC::RichTextDrawingHandler]
591
+ # @return [void]
592
+ def self.insert_drawing_handler(handler) end
593
+
594
+ # Removes a drawing handler.
595
+ # @param name [String]
596
+ # @return [Boolean]
597
+ def self.remove_drawing_handler(name) end
598
+
599
+ # Finds a drawing handler by name.
600
+ # @param name [String]
601
+ # @return [Wx::RTC::RichTextDrawingHandler]
602
+ def self.find_drawing_handler(name) end
603
+
604
+ # Clean up drawing handlers.
605
+ # @return [void]
606
+ def self.clean_up_drawing_handlers; end
607
+
608
+ # Adds a field type.
609
+ #
610
+ #
611
+ # @see Wx::RTC::RichTextBuffer.remove_field_type
612
+ # @see Wx::RTC::RichTextBuffer.find_field_type
613
+ # @see Wx::RTC::RichTextField
614
+ # @see Wx::RTC::RichTextFieldType
615
+ # @see Wx::RTC::RichTextFieldTypeStandard
616
+ # @param fieldType [Wx::RTC::RichTextFieldType]
617
+ # @return [void]
618
+ def self.add_field_type(fieldType) end
619
+
620
+ # Removes a field type by name.
621
+ #
622
+ #
623
+ # @see Wx::RTC::RichTextBuffer.add_field_type
624
+ # @see Wx::RTC::RichTextBuffer.find_field_type
625
+ # @see Wx::RTC::RichTextField
626
+ # @see Wx::RTC::RichTextFieldType
627
+ # @see Wx::RTC::RichTextFieldTypeStandard
628
+ # @param name [String]
629
+ # @return [Boolean]
630
+ def self.remove_field_type(name) end
631
+
632
+ # Finds a field type by name.
633
+ #
634
+ #
635
+ # @see Wx::RTC::RichTextBuffer.remove_field_type
636
+ # @see Wx::RTC::RichTextBuffer.add_field_type
637
+ # @see Wx::RTC::RichTextField
638
+ # @see Wx::RTC::RichTextFieldType
639
+ # @see Wx::RTC::RichTextFieldTypeStandard
640
+ # @param name [String]
641
+ # @return [Wx::RTC::RichTextFieldType]
642
+ def self.find_field_type(name) end
643
+
644
+ # Cleans up field types.
645
+ # @return [void]
646
+ def self.clean_up_field_types; end
647
+
648
+ # Returns the minimum margin between bullet and paragraph in 10ths of a mm.
649
+ # @return [Integer]
650
+ def self.get_bullet_right_margin; end
651
+
652
+ # Sets the minimum margin between bullet and paragraph in 10ths of a mm.
653
+ # @param margin [Integer]
654
+ # @return [void]
655
+ def self.set_bullet_right_margin(margin) end
656
+
657
+ # Returns the factor to multiply by character height to get a reasonable bullet size.
658
+ # @return [Float]
659
+ def self.get_bullet_proportion; end
660
+
661
+ # Sets the factor to multiply by character height to get a reasonable bullet size.
662
+ # @param prop [Float]
663
+ # @return [void]
664
+ def self.set_bullet_proportion(prop) end
665
+
666
+ # Returns the floating layout mode.
667
+ #
668
+ # The default is true, where objects are laid out according to their floating status.
669
+ # @return [Boolean]
670
+ def self.get_floating_layout_mode; end
671
+
672
+ # Sets the floating layout mode.
673
+ #
674
+ # Pass false to speed up editing by not performing floating layout. This setting affects all buffers.
675
+ # @param mode [Boolean]
676
+ # @return [void]
677
+ def self.set_floating_layout_mode(mode) end
678
+
679
+ end # RichTextBuffer
680
+
681
+ # Manages quick access to a pool of fonts for rendering rich text.
608
682
  #
609
- # @see Wx::RTC::RichTextBuffer.remove_field_type
610
- # @see Wx::RTC::RichTextBuffer.find_field_type
611
- # @see Wx::RTC::RichTextField
612
- # @see Wx::RTC::RichTextFieldType
613
- # @see Wx::RTC::RichTextFieldTypeStandard
614
- # @param fieldType [Wx::RTC::RichTextFieldType]
615
- # @return [void]
616
- def self.add_field_type(fieldType) end
617
-
618
- # Removes a field type by name.
683
+ # Category: Rich Text
684
+ # @see Wx::RTC::RichTextBuffer
685
+ # @see Wx::RTC::RichTextCtrl
619
686
  #
620
687
  #
621
- # @see Wx::RTC::RichTextBuffer.add_field_type
622
- # @see Wx::RTC::RichTextBuffer.find_field_type
623
- # @see Wx::RTC::RichTextField
624
- # @see Wx::RTC::RichTextFieldType
625
- # @see Wx::RTC::RichTextFieldTypeStandard
626
- # @param name [String]
627
- # @return [Boolean]
628
- def self.remove_field_type(name) end
629
-
630
- # Finds a field type by name.
688
+ # @wxrb_require USE_RICHTEXT
689
+ class RichTextFontTable < Object
690
+
691
+ # @overload initialize()
692
+ # Default constructor.
693
+ # @return [Wx::RTC::RichTextFontTable]
694
+ # @overload initialize(table)
695
+ # Copy constructor.
696
+ # @param table [Wx::RTC::RichTextFontTable]
697
+ # @return [Wx::RTC::RichTextFontTable]
698
+ def initialize(*args) end
699
+
700
+ # Returns true if the font table is valid.
701
+ # @return [Boolean]
702
+ def is_ok; end
703
+ alias_method :ok?, :is_ok
704
+
705
+ # Finds a font for the given attribute object.
706
+ # @param fontSpec [Wx::RTC::RichTextAttr]
707
+ # @return [Wx::Font]
708
+ def find_font(fontSpec) end
709
+
710
+ # Clears the font table.
711
+ # @return [void]
712
+ def clear; end
713
+
714
+ # Equality operator.
715
+ # @param table [Wx::RTC::RichTextFontTable]
716
+ # @return [Boolean]
717
+ def ==(table) end
718
+
719
+ # Set the font scale factor.
720
+ # @param fontScale [Float]
721
+ # @return [void]
722
+ def set_font_scale(fontScale) end
723
+ alias_method :font_scale=, :set_font_scale
724
+
725
+ end # RichTextFontTable
726
+
727
+ # The base class for custom field types.
631
728
  #
729
+ # Each type definition handles one field type. Override functions to provide drawing, layout, updating and property editing functionality for a field.
730
+ # Register field types on application initialisation with the static function {Wx::RTC::RichTextBuffer.add_field_type}. They will be deleted automatically on application exit.
632
731
  #
633
- # @see Wx::RTC::RichTextBuffer.remove_field_type
634
- # @see Wx::RTC::RichTextBuffer.add_field_type
732
+ # Category: Rich Text
733
+ # @see Wx::RTC::RichTextFieldTypeStandard
635
734
  # @see Wx::RTC::RichTextField
636
- # @see Wx::RTC::RichTextFieldType
637
- # @see Wx::RTC::RichTextFieldTypeStandard
638
- # @param name [String]
639
- # @return [Wx::RTC::RichTextFieldType]
640
- def self.find_field_type(name) end
641
-
642
- # Cleans up field types.
643
- # @return [void]
644
- def self.clean_up_field_types; end
645
-
646
- # Returns the minimum margin between bullet and paragraph in 10ths of a mm.
647
- # @return [Integer]
648
- def self.get_bullet_right_margin; end
649
-
650
- # Sets the minimum margin between bullet and paragraph in 10ths of a mm.
651
- # @param margin [Integer]
652
- # @return [void]
653
- def self.set_bullet_right_margin(margin) end
654
-
655
- # Returns the factor to multiply by character height to get a reasonable bullet size.
656
- # @return [Float]
657
- def self.get_bullet_proportion; end
658
-
659
- # Sets the factor to multiply by character height to get a reasonable bullet size.
660
- # @param prop [Float]
661
- # @return [void]
662
- def self.set_bullet_proportion(prop) end
663
-
664
- # Returns the floating layout mode.
665
- #
666
- # The default is true, where objects are laid out according to their floating status.
667
- # @return [Boolean]
668
- def self.get_floating_layout_mode; end
669
-
670
- # Sets the floating layout mode.
671
- #
672
- # Pass false to speed up editing by not performing floating layout. This setting affects all buffers.
673
- # @param mode [Boolean]
674
- # @return [void]
675
- def self.set_floating_layout_mode(mode) end
676
-
677
- end # RichTextBuffer
678
-
679
- # Manages quick access to a pool of fonts for rendering rich text.
680
- #
681
- # Category: Rich Text
682
- # @see Wx::RTC::RichTextBuffer
683
- # @see Wx::RTC::RichTextCtrl
684
- #
685
- #
686
- # @wxrb_require USE_RICHTEXT
687
- class RichTextFontTable < Object
688
-
689
- # @overload initialize()
690
- # Default constructor.
691
- # @return [Wx::RTC::RichTextFontTable]
692
- # @overload initialize(table)
693
- # Copy constructor.
694
- # @param table [Wx::RTC::RichTextFontTable]
695
- # @return [Wx::RTC::RichTextFontTable]
696
- def initialize(*args) end
697
-
698
- # Returns true if the font table is valid.
699
- # @return [Boolean]
700
- def is_ok; end
701
- alias_method :ok?, :is_ok
702
-
703
- # Finds a font for the given attribute object.
704
- # @param fontSpec [Wx::RTC::RichTextAttr]
705
- # @return [Wx::Font]
706
- def find_font(fontSpec) end
707
-
708
- # Clears the font table.
709
- # @return [void]
710
- def clear; end
711
-
712
- # Equality operator.
713
- # @param table [Wx::RTC::RichTextFontTable]
714
- # @return [Boolean]
715
- def ==(table) end
716
-
717
- # Set the font scale factor.
718
- # @param fontScale [Float]
719
- # @return [void]
720
- def set_font_scale(fontScale) end
721
- alias_method :font_scale=, :set_font_scale
722
-
723
- end # RichTextFontTable
724
-
725
- # The base class for custom field types.
726
- #
727
- # Each type definition handles one field type. Override functions to provide drawing, layout, updating and property editing functionality for a field.
728
- # Register field types on application initialisation with the static function {Wx::RTC::RichTextBuffer.add_field_type}. They will be deleted automatically on application exit.
729
- #
730
- # Category: Rich Text
731
- # @see Wx::RTC::RichTextFieldTypeStandard
732
- # @see Wx::RTC::RichTextField
733
- # @see Wx::RTC::RichTextCtrl
734
- #
735
- #
736
- # @wxrb_require USE_RICHTEXT
737
- class RichTextFieldType < Object
738
-
739
- # @overload initialize(name=(''))
740
- # Creates a field type definition.
741
- # @param name [String]
742
- # @return [Wx::RTC::RichTextFieldType]
743
- # @overload initialize(fieldType)
744
- # Copy constructor.
745
- # @param fieldType [Wx::RTC::RichTextFieldType]
746
- # @return [Wx::RTC::RichTextFieldType]
747
- def initialize(*args) end
748
-
749
- # @param fieldType [Wx::RTC::RichTextFieldType]
750
- # @return [void]
751
- def copy(fieldType) end
752
-
753
- # Draw the item, within the given range.
754
- #
755
- # Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)
756
- # @param obj [Wx::RTC::RichTextField]
757
- # @param dc [Wx::DC]
758
- # @param context [Wx::RTC::RichTextDrawingContext]
759
- # @param range [Range]
760
- # @param selection [Wx::RTC::RichTextSelection]
761
- # @param rect [Wx::Rect]
762
- # @param descent [Integer]
763
- # @param style [Integer]
764
- # @return [Boolean]
765
- def draw(obj, dc, context, range, selection, rect, descent, style) end
766
-
767
- # Lay the item out at the specified position with the given size constraint.
768
- #
769
- # Layout must set the cached size. rect is the available space for the object, and parentRect is the container that is used to determine a relative size or position (for example if a text box must be 50% of the parent text box).
770
- # @param obj [Wx::RTC::RichTextField]
771
- # @param dc [Wx::DC]
772
- # @param context [Wx::RTC::RichTextDrawingContext]
773
- # @param rect [Wx::Rect]
774
- # @param parentRect [Wx::Rect]
775
- # @param style [Integer]
776
- # @return [Boolean]
777
- def layout(obj, dc, context, rect, parentRect, style) end
778
-
779
- # Returns the object size for the given range.
780
- #
781
- # Returns false if the range is invalid for this object.
782
- # @param obj [Wx::RTC::RichTextField]
783
- # @param range [Range]
784
- # @param size [Array(Integer, Integer), Wx::Size]
785
- # @param descent [Integer]
786
- # @param dc [Wx::DC]
787
- # @param context [Wx::RTC::RichTextDrawingContext]
788
- # @param flags [Integer]
789
- # @param position [Array(Integer, Integer), Wx::Point]
790
- # @param parentSize [Array(Integer, Integer), Wx::Size]
791
- # @param partialExtents [Array,nil]
792
- # @return [Array(Boolean,Integer)]
793
- def get_range_size(obj, range, size, descent, dc, context, flags, position=(Wx::Point.new(0, 0)), parentSize=Wx::DEFAULT_SIZE, partialExtents=nil) end
794
- alias_method :range_size, :get_range_size
795
-
796
- # Returns true if we can edit the object's properties via a GUI.
797
- # @param obj [Wx::RTC::RichTextField]
798
- # @return [Boolean]
799
- def can_edit_properties(obj) end
800
- alias_method :can_edit_properties?, :can_edit_properties
801
-
802
- # Edits the object's properties via a GUI.
803
- # @param obj [Wx::RTC::RichTextField]
804
- # @param parent [Wx::Window]
805
- # @param buffer [Wx::RTC::RichTextBuffer]
806
- # @return [Boolean]
807
- def edit_properties(obj, parent, buffer) end
808
-
809
- # Returns the label to be used for the properties context menu item.
810
- # @param obj [Wx::RTC::RichTextField]
811
- # @return [String]
812
- def get_properties_menu_label(obj) end
813
- alias_method :properties_menu_label, :get_properties_menu_label
814
-
815
- # Update the field.
816
- #
817
- # This would typically expand the field to its value, if this is a dynamically changing and/or composite field.
818
- # @param buffer [Wx::RTC::RichTextBuffer]
819
- # @param obj [Wx::RTC::RichTextField]
820
- # @return [Boolean]
821
- def update_field(buffer, obj) end
822
-
823
- # Returns true if this object is top-level, i.e. contains its own paragraphs, such as a text box.
824
- # @param obj [Wx::RTC::RichTextField]
825
- # @return [Boolean]
826
- def is_top_level(obj) end
827
- alias_method :top_level?, :is_top_level
828
-
829
- # Sets the field type name.
735
+ # @see Wx::RTC::RichTextCtrl
830
736
  #
831
- # There should be a unique name per field type object.
832
- # @param name [String]
833
- # @return [void]
834
- def set_name(name) end
835
- alias_method :name=, :set_name
836
-
837
- # Returns the field type name.
838
737
  #
839
- # There should be a unique name per field type object.
840
- # @return [String]
841
- def get_name; end
842
- alias_method :name, :get_name
843
-
844
- end # RichTextFieldType
845
-
846
- # A field type that can handle fields with text or bitmap labels, with a small range of styles for implementing rectangular fields and fields that can be used for start and end tags.
847
- #
848
- # The border, text and background colours can be customised; the default is white text on a black background.
849
- # The following display styles can be used.
850
- # ### Styles
851
- #
852
- # This class supports the following styles:
853
- #
854
- # - {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_COMPOSITE}: Creates a composite field; you will probably need to derive a new class to implement UpdateField.
855
- #
856
- # - {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_RECTANGLE}: Shows a rounded rectangle background.
857
- #
858
- # - {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_NO_BORDER}: Suppresses the background and border; mostly used with a bitmap label.
859
- #
860
- # - {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_START_TAG}: Shows a start tag background, with the pointy end facing right.
861
- #
862
- # - {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_END_TAG}: Shows an end tag background, with the pointy end facing left.
863
- #
864
- # Category: Rich Text
865
- # @see Wx::RTC::RichTextFieldType
866
- # @see Wx::RTC::RichTextField
867
- # @see Wx::RTC::RichTextBuffer
868
- # @see Wx::RTC::RichTextCtrl
869
- #
870
- #
871
- # @wxrb_require USE_RICHTEXT
872
- class RichTextFieldTypeStandard < RichTextFieldType
873
-
738
+ # @wxrb_require USE_RICHTEXT
739
+ class RichTextFieldType < Object
740
+
741
+ # @overload initialize(name=(''))
742
+ # Creates a field type definition.
743
+ # @param name [String]
744
+ # @return [Wx::RTC::RichTextFieldType]
745
+ # @overload initialize(fieldType)
746
+ # Copy constructor.
747
+ # @param fieldType [Wx::RTC::RichTextFieldType]
748
+ # @return [Wx::RTC::RichTextFieldType]
749
+ def initialize(*args) end
750
+
751
+ # @param fieldType [Wx::RTC::RichTextFieldType]
752
+ # @return [void]
753
+ def copy(fieldType) end
754
+
755
+ # Draw the item, within the given range.
756
+ #
757
+ # Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)
758
+ # @param obj [Wx::RTC::RichTextField]
759
+ # @param dc [Wx::DC]
760
+ # @param context [Wx::RTC::RichTextDrawingContext]
761
+ # @param range [Range]
762
+ # @param selection [Wx::RTC::RichTextSelection]
763
+ # @param rect [Wx::Rect]
764
+ # @param descent [Integer]
765
+ # @param style [Integer]
766
+ # @return [Boolean]
767
+ def draw(obj, dc, context, range, selection, rect, descent, style) end
768
+
769
+ # Lay the item out at the specified position with the given size constraint.
770
+ #
771
+ # Layout must set the cached size. rect is the available space for the object, and parentRect is the container that is used to determine a relative size or position (for example if a text box must be 50% of the parent text box).
772
+ # @param obj [Wx::RTC::RichTextField]
773
+ # @param dc [Wx::DC]
774
+ # @param context [Wx::RTC::RichTextDrawingContext]
775
+ # @param rect [Wx::Rect]
776
+ # @param parentRect [Wx::Rect]
777
+ # @param style [Integer]
778
+ # @return [Boolean]
779
+ def layout(obj, dc, context, rect, parentRect, style) end
780
+
781
+ # Returns the object size for the given range.
782
+ #
783
+ # Returns false if the range is invalid for this object.
784
+ # @param obj [Wx::RTC::RichTextField]
785
+ # @param range [Range]
786
+ # @param size [Array(Integer, Integer), Wx::Size]
787
+ # @param descent [Integer]
788
+ # @param dc [Wx::DC]
789
+ # @param context [Wx::RTC::RichTextDrawingContext]
790
+ # @param flags [Integer]
791
+ # @param position [Array(Integer, Integer), Wx::Point]
792
+ # @param parentSize [Array(Integer, Integer), Wx::Size]
793
+ # @param partialExtents [Array,nil]
794
+ # @return [Array(Boolean,Integer)]
795
+ def get_range_size(obj, range, size, descent, dc, context, flags, position=(Wx::Point.new(0, 0)), parentSize=Wx::DEFAULT_SIZE, partialExtents=nil) end
796
+ alias_method :range_size, :get_range_size
797
+
798
+ # Returns true if we can edit the object's properties via a GUI.
799
+ # @param obj [Wx::RTC::RichTextField]
800
+ # @return [Boolean]
801
+ def can_edit_properties(obj) end
802
+ alias_method :can_edit_properties?, :can_edit_properties
803
+
804
+ # Edits the object's properties via a GUI.
805
+ # @param obj [Wx::RTC::RichTextField]
806
+ # @param parent [Wx::Window]
807
+ # @param buffer [Wx::RTC::RichTextBuffer]
808
+ # @return [Boolean]
809
+ def edit_properties(obj, parent, buffer) end
810
+
811
+ # Returns the label to be used for the properties context menu item.
812
+ # @param obj [Wx::RTC::RichTextField]
813
+ # @return [String]
814
+ def get_properties_menu_label(obj) end
815
+ alias_method :properties_menu_label, :get_properties_menu_label
816
+
817
+ # Update the field.
818
+ #
819
+ # This would typically expand the field to its value, if this is a dynamically changing and/or composite field.
820
+ # @param buffer [Wx::RTC::RichTextBuffer]
821
+ # @param obj [Wx::RTC::RichTextField]
822
+ # @return [Boolean]
823
+ def update_field(buffer, obj) end
824
+
825
+ # Returns true if this object is top-level, i.e. contains its own paragraphs, such as a text box.
826
+ # @param obj [Wx::RTC::RichTextField]
827
+ # @return [Boolean]
828
+ def is_top_level(obj) end
829
+ alias_method :top_level?, :is_top_level
830
+
831
+ # Sets the field type name.
832
+ #
833
+ # There should be a unique name per field type object.
834
+ # @param name [String]
835
+ # @return [void]
836
+ def set_name(name) end
837
+ alias_method :name=, :set_name
838
+
839
+ # Returns the field type name.
840
+ #
841
+ # There should be a unique name per field type object.
842
+ # @return [String]
843
+ def get_name; end
844
+ alias_method :name, :get_name
845
+
846
+ end # RichTextFieldType
847
+
848
+ # A field type that can handle fields with text or bitmap labels, with a small range of styles for implementing rectangular fields and fields that can be used for start and end tags.
874
849
  #
850
+ # The border, text and background colours can be customised; the default is white text on a black background.
851
+ # The following display styles can be used.
852
+ # ### Styles
875
853
  #
876
- RICHTEXT_FIELD_STYLE_COMPOSITE = 1
877
-
854
+ # This class supports the following styles:
878
855
  #
856
+ # - {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_COMPOSITE}: Creates a composite field; you will probably need to derive a new class to implement UpdateField.
879
857
  #
880
- RICHTEXT_FIELD_STYLE_RECTANGLE = 2
881
-
858
+ # - {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_RECTANGLE}: Shows a rounded rectangle background.
882
859
  #
860
+ # - {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_NO_BORDER}: Suppresses the background and border; mostly used with a bitmap label.
883
861
  #
884
- RICHTEXT_FIELD_STYLE_NO_BORDER = 4
885
-
862
+ # - {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_START_TAG}: Shows a start tag background, with the pointy end facing right.
886
863
  #
864
+ # - {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_END_TAG}: Shows an end tag background, with the pointy end facing left.
887
865
  #
888
- RICHTEXT_FIELD_STYLE_START_TAG = 8
889
-
866
+ # Category: Rich Text
867
+ # @see Wx::RTC::RichTextFieldType
868
+ # @see Wx::RTC::RichTextField
869
+ # @see Wx::RTC::RichTextBuffer
870
+ # @see Wx::RTC::RichTextCtrl
890
871
  #
891
872
  #
892
- RICHTEXT_FIELD_STYLE_END_TAG = 16
893
-
894
- # @overload initialize(name, label, displayStyle=Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_RECTANGLE)
895
- # Constructor, creating a field type definition with a text label.
896
- # @param name [String] The name of the type definition. This must be unique, and is the type name used when adding a field to a control.
897
- # @param label [String] The text label to be shown on the field.
898
- # @param displayStyle [Integer] The display style: one of {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_RECTANGLE}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_NO_BORDER}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_START_TAG}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_END_TAG}.
899
- # @return [Wx::RTC::RichTextFieldTypeStandard]
900
- # @overload initialize(name, bitmap, displayStyle=Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_NO_BORDER)
901
- # Constructor, creating a field type definition with a bitmap label.
902
- # @param name [String] The name of the type definition. This must be unique, and is the type name used when adding a field to a control.
903
- # @param bitmap [Wx::Bitmap] The bitmap label to be shown on the field.
904
- # @param displayStyle [Integer] The display style: one of {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_RECTANGLE}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_NO_BORDER}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_START_TAG}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_END_TAG}.
905
- # @return [Wx::RTC::RichTextFieldTypeStandard]
906
- # @overload initialize()
907
- # The default constructor.
908
- # @return [Wx::RTC::RichTextFieldTypeStandard]
909
- # @overload initialize(field)
910
- # The copy constructor.
911
- # @param field [Wx::RTC::RichTextFieldTypeStandard]
912
- # @return [Wx::RTC::RichTextFieldTypeStandard]
913
- def initialize(*args) end
914
-
915
- # Initialises the object.
916
- # @return [void]
917
- def init; end
918
-
919
- # Copies the object.
920
- # @param field [Wx::RTC::RichTextFieldTypeStandard]
921
- # @return [void]
922
- def copy(field) end
923
-
924
- # Draw the item, within the given range.
873
+ # @wxrb_require USE_RICHTEXT
874
+ class RichTextFieldTypeStandard < RichTextFieldType
875
+
876
+ #
877
+ #
878
+ RICHTEXT_FIELD_STYLE_COMPOSITE = 1
879
+
880
+ #
881
+ #
882
+ RICHTEXT_FIELD_STYLE_RECTANGLE = 2
883
+
884
+ #
885
+ #
886
+ RICHTEXT_FIELD_STYLE_NO_BORDER = 4
887
+
888
+ #
889
+ #
890
+ RICHTEXT_FIELD_STYLE_START_TAG = 8
891
+
892
+ #
893
+ #
894
+ RICHTEXT_FIELD_STYLE_END_TAG = 16
895
+
896
+ # @overload initialize(name, label, displayStyle=Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_RECTANGLE)
897
+ # Constructor, creating a field type definition with a text label.
898
+ # @param name [String] The name of the type definition. This must be unique, and is the type name used when adding a field to a control.
899
+ # @param label [String] The text label to be shown on the field.
900
+ # @param displayStyle [Integer] The display style: one of {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_RECTANGLE}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_NO_BORDER}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_START_TAG}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_END_TAG}.
901
+ # @return [Wx::RTC::RichTextFieldTypeStandard]
902
+ # @overload initialize(name, bitmap, displayStyle=Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_NO_BORDER)
903
+ # Constructor, creating a field type definition with a bitmap label.
904
+ # @param name [String] The name of the type definition. This must be unique, and is the type name used when adding a field to a control.
905
+ # @param bitmap [Wx::Bitmap] The bitmap label to be shown on the field.
906
+ # @param displayStyle [Integer] The display style: one of {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_RECTANGLE}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_NO_BORDER}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_START_TAG}, {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_END_TAG}.
907
+ # @return [Wx::RTC::RichTextFieldTypeStandard]
908
+ # @overload initialize()
909
+ # The default constructor.
910
+ # @return [Wx::RTC::RichTextFieldTypeStandard]
911
+ # @overload initialize(field)
912
+ # The copy constructor.
913
+ # @param field [Wx::RTC::RichTextFieldTypeStandard]
914
+ # @return [Wx::RTC::RichTextFieldTypeStandard]
915
+ def initialize(*args) end
916
+
917
+ # Initialises the object.
918
+ # @return [void]
919
+ def init; end
920
+
921
+ # Copies the object.
922
+ # @param field [Wx::RTC::RichTextFieldTypeStandard]
923
+ # @return [void]
924
+ def copy(field) end
925
+
926
+ # Draw the item, within the given range.
927
+ #
928
+ # Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)
929
+ # @param obj [Wx::RTC::RichTextField]
930
+ # @param dc [Wx::DC]
931
+ # @param context [Wx::RTC::RichTextDrawingContext]
932
+ # @param range [Range]
933
+ # @param selection [Wx::RTC::RichTextSelection]
934
+ # @param rect [Wx::Rect]
935
+ # @param descent [Integer]
936
+ # @param style [Integer]
937
+ # @return [Boolean]
938
+ def draw(obj, dc, context, range, selection, rect, descent, style) end
939
+
940
+ # Lay the item out at the specified position with the given size constraint.
941
+ #
942
+ # Layout must set the cached size. rect is the available space for the object, and parentRect is the container that is used to determine a relative size or position (for example if a text box must be 50% of the parent text box).
943
+ # @param obj [Wx::RTC::RichTextField]
944
+ # @param dc [Wx::DC]
945
+ # @param context [Wx::RTC::RichTextDrawingContext]
946
+ # @param rect [Wx::Rect]
947
+ # @param parentRect [Wx::Rect]
948
+ # @param style [Integer]
949
+ # @return [Boolean]
950
+ def layout(obj, dc, context, rect, parentRect, style) end
951
+
952
+ # Returns the object size for the given range.
953
+ #
954
+ # Returns false if the range is invalid for this object.
955
+ # @param obj [Wx::RTC::RichTextField]
956
+ # @param range [Range]
957
+ # @param size [Array(Integer, Integer), Wx::Size]
958
+ # @param descent [Integer]
959
+ # @param dc [Wx::DC]
960
+ # @param context [Wx::RTC::RichTextDrawingContext]
961
+ # @param flags [Integer]
962
+ # @param position [Array(Integer, Integer), Wx::Point]
963
+ # @param parentSize [Array(Integer, Integer), Wx::Size]
964
+ # @param partialExtents [Array,nil]
965
+ # @return [Array(Boolean,Integer)]
966
+ def get_range_size(obj, range, size, descent, dc, context, flags, position=(Wx::Point.new(0, 0)), parentSize=Wx::DEFAULT_SIZE, partialExtents=nil) end
967
+ alias_method :range_size, :get_range_size
968
+
969
+ # Get the size of the field, given the label, font size, and so on.
970
+ # @param obj [Wx::RTC::RichTextField]
971
+ # @param dc [Wx::DC]
972
+ # @param context [Wx::RTC::RichTextDrawingContext]
973
+ # @param style [Integer]
974
+ # @return [Wx::Size]
975
+ def get_size(obj, dc, context, style) end
976
+ alias_method :size, :get_size
977
+
978
+ # Returns true if the display type is {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_COMPOSITE}, false otherwise.
979
+ # @param obj [Wx::RTC::RichTextField]
980
+ # @return [Boolean]
981
+ def is_top_level(obj) end
982
+ alias_method :top_level?, :is_top_level
983
+
984
+ # Sets the text label for fields of this type.
985
+ # @param label [String]
986
+ # @return [void]
987
+ def set_label(label) end
988
+ alias_method :label=, :set_label
989
+
990
+ # Returns the text label for fields of this type.
991
+ # @return [Wx::String]
992
+ def get_label; end
993
+ alias_method :label, :get_label
994
+
995
+ # Sets the bitmap label for fields of this type.
996
+ # @param bitmap [Wx::Bitmap]
997
+ # @return [void]
998
+ def set_bitmap(bitmap) end
999
+ alias_method :bitmap=, :set_bitmap
1000
+
1001
+ # Gets the bitmap label for fields of this type.
1002
+ # @return [Wx::Bitmap]
1003
+ def get_bitmap; end
1004
+ alias_method :bitmap, :get_bitmap
1005
+
1006
+ # Gets the display style for fields of this type.
1007
+ # @return [Integer]
1008
+ def get_display_style; end
1009
+ alias_method :display_style, :get_display_style
1010
+
1011
+ # Sets the display style for fields of this type.
1012
+ # @param displayStyle [Integer]
1013
+ # @return [void]
1014
+ def set_display_style(displayStyle) end
1015
+ alias_method :display_style=, :set_display_style
1016
+
1017
+ # Gets the font used for drawing the text label.
1018
+ # @return [Wx::Font,Wx::FontInfo]
1019
+ def get_font; end
1020
+ alias_method :font, :get_font
1021
+
1022
+ # Sets the font used for drawing the text label.
1023
+ # @param font [Wx::Font,Wx::FontInfo]
1024
+ # @return [void]
1025
+ def set_font(font) end
1026
+ alias_method :font=, :set_font
1027
+
1028
+ # Gets the colour used for drawing the text label.
1029
+ # @return [Wx::Colour,String,Symbol]
1030
+ def get_text_colour; end
1031
+ alias_method :text_colour, :get_text_colour
1032
+
1033
+ # Sets the colour used for drawing the text label.
1034
+ # @param colour [Wx::Colour,String,Symbol]
1035
+ # @return [void]
1036
+ def set_text_colour(colour) end
1037
+ alias_method :text_colour=, :set_text_colour
1038
+
1039
+ # Gets the colour used for drawing the field border.
1040
+ # @return [Wx::Colour,String,Symbol]
1041
+ def get_border_colour; end
1042
+ alias_method :border_colour, :get_border_colour
1043
+
1044
+ # Sets the colour used for drawing the field border.
1045
+ # @param colour [Wx::Colour,String,Symbol]
1046
+ # @return [void]
1047
+ def set_border_colour(colour) end
1048
+ alias_method :border_colour=, :set_border_colour
1049
+
1050
+ # Gets the colour used for drawing the field background.
1051
+ # @return [Wx::Colour,String,Symbol]
1052
+ def get_background_colour; end
1053
+ alias_method :background_colour, :get_background_colour
1054
+
1055
+ # Sets the colour used for drawing the field background.
1056
+ # @param colour [Wx::Colour,String,Symbol]
1057
+ # @return [void]
1058
+ def set_background_colour(colour) end
1059
+ alias_method :background_colour=, :set_background_colour
1060
+
1061
+ # Sets the vertical padding (the distance between the border and the text).
1062
+ # @param padding [Integer]
1063
+ # @return [void]
1064
+ def set_vertical_padding(padding) end
1065
+ alias_method :vertical_padding=, :set_vertical_padding
1066
+
1067
+ # Gets the vertical padding (the distance between the border and the text).
1068
+ # @return [Integer]
1069
+ def get_vertical_padding; end
1070
+ alias_method :vertical_padding, :get_vertical_padding
1071
+
1072
+ # Sets the horizontal padding (the distance between the border and the text).
1073
+ # @param padding [Integer]
1074
+ # @return [void]
1075
+ def set_horizontal_padding(padding) end
1076
+ alias_method :horizontal_padding=, :set_horizontal_padding
1077
+
1078
+ # Sets the horizontal padding (the distance between the border and the text).
1079
+ # @return [Integer]
1080
+ def get_horizontal_padding; end
1081
+ alias_method :horizontal_padding, :get_horizontal_padding
1082
+
1083
+ # Sets the horizontal margin surrounding the field object.
1084
+ # @param margin [Integer]
1085
+ # @return [void]
1086
+ def set_horizontal_margin(margin) end
1087
+ alias_method :horizontal_margin=, :set_horizontal_margin
1088
+
1089
+ # Gets the horizontal margin surrounding the field object.
1090
+ # @return [Integer]
1091
+ def get_horizontal_margin; end
1092
+ alias_method :horizontal_margin, :get_horizontal_margin
1093
+
1094
+ # Sets the vertical margin surrounding the field object.
1095
+ # @param margin [Integer]
1096
+ # @return [void]
1097
+ def set_vertical_margin(margin) end
1098
+ alias_method :vertical_margin=, :set_vertical_margin
1099
+
1100
+ # Gets the vertical margin surrounding the field object.
1101
+ # @return [Integer]
1102
+ def get_vertical_margin; end
1103
+ alias_method :vertical_margin, :get_vertical_margin
1104
+
1105
+ end # RichTextFieldTypeStandard
1106
+
1107
+ # The base class for custom drawing handlers.
925
1108
  #
926
- # Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)
927
- # @param obj [Wx::RTC::RichTextField]
928
- # @param dc [Wx::DC]
929
- # @param context [Wx::RTC::RichTextDrawingContext]
930
- # @param range [Range]
931
- # @param selection [Wx::RTC::RichTextSelection]
932
- # @param rect [Wx::Rect]
933
- # @param descent [Integer]
934
- # @param style [Integer]
935
- # @return [Boolean]
936
- def draw(obj, dc, context, range, selection, rect, descent, style) end
937
-
938
- # Lay the item out at the specified position with the given size constraint.
1109
+ # Currently, drawing handlers can provide virtual attributes.
939
1110
  #
940
- # Layout must set the cached size. rect is the available space for the object, and parentRect is the container that is used to determine a relative size or position (for example if a text box must be 50% of the parent text box).
941
- # @param obj [Wx::RTC::RichTextField]
942
- # @param dc [Wx::DC]
943
- # @param context [Wx::RTC::RichTextDrawingContext]
944
- # @param rect [Wx::Rect]
945
- # @param parentRect [Wx::Rect]
946
- # @param style [Integer]
947
- # @return [Boolean]
948
- def layout(obj, dc, context, rect, parentRect, style) end
949
-
950
- # Returns the object size for the given range.
1111
+ # Category: Rich Text
1112
+ # @see Wx::RTC::RichTextBuffer
1113
+ # @see Wx::RTC::RichTextCtrl
951
1114
  #
952
- # Returns false if the range is invalid for this object.
953
- # @param obj [Wx::RTC::RichTextField]
954
- # @param range [Range]
955
- # @param size [Array(Integer, Integer), Wx::Size]
956
- # @param descent [Integer]
957
- # @param dc [Wx::DC]
958
- # @param context [Wx::RTC::RichTextDrawingContext]
959
- # @param flags [Integer]
960
- # @param position [Array(Integer, Integer), Wx::Point]
961
- # @param parentSize [Array(Integer, Integer), Wx::Size]
962
- # @param partialExtents [Array,nil]
963
- # @return [Array(Boolean,Integer)]
964
- def get_range_size(obj, range, size, descent, dc, context, flags, position=(Wx::Point.new(0, 0)), parentSize=Wx::DEFAULT_SIZE, partialExtents=nil) end
965
- alias_method :range_size, :get_range_size
966
-
967
- # Get the size of the field, given the label, font size, and so on.
968
- # @param obj [Wx::RTC::RichTextField]
969
- # @param dc [Wx::DC]
970
- # @param context [Wx::RTC::RichTextDrawingContext]
971
- # @param style [Integer]
972
- # @return [Wx::Size]
973
- def get_size(obj, dc, context, style) end
974
- alias_method :size, :get_size
975
-
976
- # Returns true if the display type is {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_COMPOSITE}, false otherwise.
977
- # @param obj [Wx::RTC::RichTextField]
978
- # @return [Boolean]
979
- def is_top_level(obj) end
980
- alias_method :top_level?, :is_top_level
981
-
982
- # Sets the text label for fields of this type.
983
- # @param label [String]
984
- # @return [void]
985
- def set_label(label) end
986
- alias_method :label=, :set_label
987
-
988
- # Returns the text label for fields of this type.
989
- # @return [Wx::String]
990
- def get_label; end
991
- alias_method :label, :get_label
992
-
993
- # Sets the bitmap label for fields of this type.
994
- # @param bitmap [Wx::Bitmap]
995
- # @return [void]
996
- def set_bitmap(bitmap) end
997
- alias_method :bitmap=, :set_bitmap
998
-
999
- # Gets the bitmap label for fields of this type.
1000
- # @return [Wx::Bitmap]
1001
- def get_bitmap; end
1002
- alias_method :bitmap, :get_bitmap
1003
-
1004
- # Gets the display style for fields of this type.
1005
- # @return [Integer]
1006
- def get_display_style; end
1007
- alias_method :display_style, :get_display_style
1008
-
1009
- # Sets the display style for fields of this type.
1010
- # @param displayStyle [Integer]
1011
- # @return [void]
1012
- def set_display_style(displayStyle) end
1013
- alias_method :display_style=, :set_display_style
1014
-
1015
- # Gets the font used for drawing the text label.
1016
- # @return [Wx::Font,Wx::FontInfo]
1017
- def get_font; end
1018
- alias_method :font, :get_font
1019
-
1020
- # Sets the font used for drawing the text label.
1021
- # @param font [Wx::Font,Wx::FontInfo]
1022
- # @return [void]
1023
- def set_font(font) end
1024
- alias_method :font=, :set_font
1025
-
1026
- # Gets the colour used for drawing the text label.
1027
- # @return [Wx::Colour,String,Symbol]
1028
- def get_text_colour; end
1029
- alias_method :text_colour, :get_text_colour
1030
-
1031
- # Sets the colour used for drawing the text label.
1032
- # @param colour [Wx::Colour,String,Symbol]
1033
- # @return [void]
1034
- def set_text_colour(colour) end
1035
- alias_method :text_colour=, :set_text_colour
1036
-
1037
- # Gets the colour used for drawing the field border.
1038
- # @return [Wx::Colour,String,Symbol]
1039
- def get_border_colour; end
1040
- alias_method :border_colour, :get_border_colour
1041
-
1042
- # Sets the colour used for drawing the field border.
1043
- # @param colour [Wx::Colour,String,Symbol]
1044
- # @return [void]
1045
- def set_border_colour(colour) end
1046
- alias_method :border_colour=, :set_border_colour
1047
-
1048
- # Gets the colour used for drawing the field background.
1049
- # @return [Wx::Colour,String,Symbol]
1050
- def get_background_colour; end
1051
- alias_method :background_colour, :get_background_colour
1052
-
1053
- # Sets the colour used for drawing the field background.
1054
- # @param colour [Wx::Colour,String,Symbol]
1055
- # @return [void]
1056
- def set_background_colour(colour) end
1057
- alias_method :background_colour=, :set_background_colour
1058
-
1059
- # Sets the vertical padding (the distance between the border and the text).
1060
- # @param padding [Integer]
1061
- # @return [void]
1062
- def set_vertical_padding(padding) end
1063
- alias_method :vertical_padding=, :set_vertical_padding
1064
-
1065
- # Gets the vertical padding (the distance between the border and the text).
1066
- # @return [Integer]
1067
- def get_vertical_padding; end
1068
- alias_method :vertical_padding, :get_vertical_padding
1069
-
1070
- # Sets the horizontal padding (the distance between the border and the text).
1071
- # @param padding [Integer]
1072
- # @return [void]
1073
- def set_horizontal_padding(padding) end
1074
- alias_method :horizontal_padding=, :set_horizontal_padding
1075
-
1076
- # Sets the horizontal padding (the distance between the border and the text).
1077
- # @return [Integer]
1078
- def get_horizontal_padding; end
1079
- alias_method :horizontal_padding, :get_horizontal_padding
1080
-
1081
- # Sets the horizontal margin surrounding the field object.
1082
- # @param margin [Integer]
1083
- # @return [void]
1084
- def set_horizontal_margin(margin) end
1085
- alias_method :horizontal_margin=, :set_horizontal_margin
1086
-
1087
- # Gets the horizontal margin surrounding the field object.
1088
- # @return [Integer]
1089
- def get_horizontal_margin; end
1090
- alias_method :horizontal_margin, :get_horizontal_margin
1091
-
1092
- # Sets the vertical margin surrounding the field object.
1093
- # @param margin [Integer]
1094
- # @return [void]
1095
- def set_vertical_margin(margin) end
1096
- alias_method :vertical_margin=, :set_vertical_margin
1097
-
1098
- # Gets the vertical margin surrounding the field object.
1099
- # @return [Integer]
1100
- def get_vertical_margin; end
1101
- alias_method :vertical_margin, :get_vertical_margin
1102
-
1103
- end # RichTextFieldTypeStandard
1104
-
1105
- # The base class for custom drawing handlers.
1106
- #
1107
- # Currently, drawing handlers can provide virtual attributes.
1108
- #
1109
- # Category: Rich Text
1110
- # @see Wx::RTC::RichTextBuffer
1111
- # @see Wx::RTC::RichTextCtrl
1112
- #
1113
- #
1114
- # @wxrb_require USE_RICHTEXT
1115
- class RichTextDrawingHandler < Object
1116
-
1117
- # Creates a drawing handler object.
1118
- # @param name [String]
1119
- # @return [Wx::RTC::RichTextDrawingHandler]
1120
- def initialize(name=('')) end
1121
-
1122
- # Returns true if this object has virtual attributes that we can provide.
1123
- # @param obj [Wx::RTC::RichTextObject]
1124
- # @return [Boolean]
1125
- def has_virtual_attributes(obj) end
1126
- alias_method :has_virtual_attributes?, :has_virtual_attributes
1127
-
1128
- # Provides virtual attributes that we can provide.
1129
- # @param attr [Wx::RTC::RichTextAttr]
1130
- # @param obj [Wx::RTC::RichTextObject]
1131
- # @return [Boolean]
1132
- def get_virtual_attributes(attr, obj) end
1133
- alias_method :virtual_attributes, :get_virtual_attributes
1134
-
1135
- # Gets the count for mixed virtual attributes for individual positions within the object.
1136
- #
1137
- # For example, individual characters within a text object may require special highlighting.
1138
- # @param obj [Wx::RTC::RichTextObject]
1139
- # @return [Integer]
1140
- def get_virtual_subobject_attributes_count(obj) end
1141
- alias_method :virtual_subobject_attributes_count, :get_virtual_subobject_attributes_count
1142
-
1143
- # Gets the mixed virtual attributes for individual positions within the object.
1144
1115
  #
1145
- # For example, individual characters within a text object may require special highlighting. Returns the number of virtual attributes found.
1146
- # @param obj [Wx::RTC::RichTextObject]
1147
- # @param positions [Array]
1148
- # @param attributes [Array]
1149
- # @return [Integer]
1150
- def get_virtual_subobject_attributes(obj, positions, attributes) end
1151
- alias_method :virtual_subobject_attributes, :get_virtual_subobject_attributes
1152
-
1153
- # Do we have virtual text for this object? Virtual text allows an application to replace characters in an object for editing and display purposes, for example for highlighting special characters.
1154
- # @param obj [Wx::RTC::RichTextPlainText]
1155
- # @return [Boolean]
1156
- def has_virtual_text(obj) end
1157
- alias_method :has_virtual_text?, :has_virtual_text
1158
-
1159
- # Gets the virtual text for this object.
1160
- # @param obj [Wx::RTC::RichTextPlainText]
1161
- # @param text [String]
1162
- # @return [Boolean]
1163
- def get_virtual_text(obj, text) end
1164
- alias_method :virtual_text, :get_virtual_text
1116
+ # @wxrb_require USE_RICHTEXT
1117
+ class RichTextDrawingHandler < Object
1118
+
1119
+ # Creates a drawing handler object.
1120
+ # @param name [String]
1121
+ # @return [Wx::RTC::RichTextDrawingHandler]
1122
+ def initialize(name=('')) end
1123
+
1124
+ # Returns true if this object has virtual attributes that we can provide.
1125
+ # @param obj [Wx::RTC::RichTextObject]
1126
+ # @return [Boolean]
1127
+ def has_virtual_attributes(obj) end
1128
+ alias_method :has_virtual_attributes?, :has_virtual_attributes
1129
+
1130
+ # Provides virtual attributes that we can provide.
1131
+ # @param attr [Wx::RTC::RichTextAttr]
1132
+ # @param obj [Wx::RTC::RichTextObject]
1133
+ # @return [Boolean]
1134
+ def get_virtual_attributes(attr, obj) end
1135
+ alias_method :virtual_attributes, :get_virtual_attributes
1136
+
1137
+ # Gets the count for mixed virtual attributes for individual positions within the object.
1138
+ #
1139
+ # For example, individual characters within a text object may require special highlighting.
1140
+ # @param obj [Wx::RTC::RichTextObject]
1141
+ # @return [Integer]
1142
+ def get_virtual_subobject_attributes_count(obj) end
1143
+ alias_method :virtual_subobject_attributes_count, :get_virtual_subobject_attributes_count
1144
+
1145
+ # Gets the mixed virtual attributes for individual positions within the object.
1146
+ #
1147
+ # For example, individual characters within a text object may require special highlighting. Returns the number of virtual attributes found.
1148
+ # @param obj [Wx::RTC::RichTextObject]
1149
+ # @param positions [Array]
1150
+ # @param attributes [Array]
1151
+ # @return [Integer]
1152
+ def get_virtual_subobject_attributes(obj, positions, attributes) end
1153
+ alias_method :virtual_subobject_attributes, :get_virtual_subobject_attributes
1154
+
1155
+ # Do we have virtual text for this object? Virtual text allows an application to replace characters in an object for editing and display purposes, for example for highlighting special characters.
1156
+ # @param obj [Wx::RTC::RichTextPlainText]
1157
+ # @return [Boolean]
1158
+ def has_virtual_text(obj) end
1159
+ alias_method :has_virtual_text?, :has_virtual_text
1160
+
1161
+ # Gets the virtual text for this object.
1162
+ # @param obj [Wx::RTC::RichTextPlainText]
1163
+ # @param text [String]
1164
+ # @return [Boolean]
1165
+ def get_virtual_text(obj, text) end
1166
+ alias_method :virtual_text, :get_virtual_text
1167
+
1168
+ # Sets the name of the handler.
1169
+ # @param name [String]
1170
+ # @return [void]
1171
+ def set_name(name) end
1172
+ alias_method :name=, :set_name
1173
+
1174
+ # Returns the name of the handler.
1175
+ # @return [String]
1176
+ def get_name; end
1177
+ alias_method :name, :get_name
1178
+
1179
+ end # RichTextDrawingHandler
1165
1180
 
1166
- # Sets the name of the handler.
1167
- # @param name [String]
1168
- # @return [void]
1169
- def set_name(name) end
1170
- alias_method :name=, :set_name
1171
-
1172
- # Returns the name of the handler.
1173
- # @return [String]
1174
- def get_name; end
1175
- alias_method :name, :get_name
1176
-
1177
- end # RichTextDrawingHandler
1178
-
1179
1181
 
1180
- end
1182
+ end
1183
+
1184
+ end