wxruby3 0.9.4-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 (390) hide show
  1. checksums.yaml +4 -4
  2. data/.wxconfig +9 -8
  3. data/INSTALL.md +315 -78
  4. data/README.md +32 -21
  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/combo_ctrl.rb +171 -0
  21. data/lib/wx/core/ext.rb +22 -3
  22. data/lib/wx/doc/comboctrl.rb +128 -3
  23. data/lib/wx/doc/gen/about_dialog_info.rb +1 -1
  24. data/lib/wx/doc/gen/accelerator.rb +1 -1
  25. data/lib/wx/doc/gen/accessible.rb +1 -1
  26. data/lib/wx/doc/gen/activity_indicator.rb +1 -1
  27. data/lib/wx/doc/gen/animation.rb +1 -1
  28. data/lib/wx/doc/gen/animation_ctrl.rb +1 -1
  29. data/lib/wx/doc/gen/any_button.rb +1 -1
  30. data/lib/wx/doc/gen/app.rb +1 -1
  31. data/lib/wx/doc/gen/app_traits.rb +3 -55
  32. data/lib/wx/doc/gen/art_provider.rb +1 -3
  33. data/lib/wx/doc/gen/aui/aui_dock_art.rb +430 -426
  34. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +34 -30
  35. data/lib/wx/doc/gen/aui/aui_manager.rb +352 -349
  36. data/lib/wx/doc/gen/aui/aui_manager_event.rb +107 -103
  37. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +157 -153
  38. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +42 -37
  39. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +109 -105
  40. data/lib/wx/doc/gen/aui/aui_notebook.rb +438 -434
  41. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +145 -141
  42. data/lib/wx/doc/gen/aui/aui_pane_info.rb +689 -685
  43. data/lib/wx/doc/gen/aui/aui_tab_art.rb +369 -365
  44. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +100 -96
  45. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +445 -441
  46. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +268 -264
  47. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +179 -175
  48. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +219 -215
  49. data/lib/wx/doc/gen/banner_window.rb +1 -1
  50. data/lib/wx/doc/gen/bitmap.rb +1 -1
  51. data/lib/wx/doc/gen/bitmap_button.rb +1 -1
  52. data/lib/wx/doc/gen/bitmap_combo_box.rb +1 -1
  53. data/lib/wx/doc/gen/book_ctrl_base.rb +1 -1
  54. data/lib/wx/doc/gen/book_ctrl_event.rb +1 -1
  55. data/lib/wx/doc/gen/box_sizer.rb +1 -1
  56. data/lib/wx/doc/gen/brush.rb +1 -1
  57. data/lib/wx/doc/gen/busy_info.rb +1 -1
  58. data/lib/wx/doc/gen/button.rb +1 -1
  59. data/lib/wx/doc/gen/calculate_layout_event.rb +1 -1
  60. data/lib/wx/doc/gen/calendar_ctrl.rb +1 -1
  61. data/lib/wx/doc/gen/calendar_date_attr.rb +1 -1
  62. data/lib/wx/doc/gen/calendar_event.rb +1 -1
  63. data/lib/wx/doc/gen/caret.rb +1 -1
  64. data/lib/wx/doc/gen/check_box.rb +1 -1
  65. data/lib/wx/doc/gen/check_list_box.rb +1 -1
  66. data/lib/wx/doc/gen/choice.rb +1 -1
  67. data/lib/wx/doc/gen/choicebook.rb +1 -1
  68. data/lib/wx/doc/gen/client_dc.rb +1 -1
  69. data/lib/wx/doc/gen/clipboard.rb +1 -1
  70. data/lib/wx/doc/gen/collapsible_pane.rb +1 -1
  71. data/lib/wx/doc/gen/collapsible_pane_event.rb +1 -1
  72. data/lib/wx/doc/gen/colour.rb +1 -2
  73. data/lib/wx/doc/gen/colour_dialog.rb +2 -2
  74. data/lib/wx/doc/gen/colour_picker_ctrl.rb +1 -1
  75. data/lib/wx/doc/gen/colour_picker_event.rb +1 -1
  76. data/lib/wx/doc/gen/combo_box.rb +4 -3
  77. data/lib/wx/doc/gen/combo_ctrl.rb +92 -228
  78. data/lib/wx/doc/gen/command_link_button.rb +1 -1
  79. data/lib/wx/doc/gen/config_base.rb +1 -1
  80. data/lib/wx/doc/gen/context_help_button.rb +1 -1
  81. data/lib/wx/doc/gen/control.rb +1 -1
  82. data/lib/wx/doc/gen/control_with_items.rb +1 -1
  83. data/lib/wx/doc/gen/core.rb +5 -5
  84. data/lib/wx/doc/gen/cursor.rb +1 -1
  85. data/lib/wx/doc/gen/data_format.rb +1 -1
  86. data/lib/wx/doc/gen/data_object.rb +1 -1
  87. data/lib/wx/doc/gen/data_object_simple_base.rb +1 -1
  88. data/lib/wx/doc/gen/date_event.rb +1 -1
  89. data/lib/wx/doc/gen/date_picker_ctrl.rb +1 -1
  90. data/lib/wx/doc/gen/dc.rb +1 -4
  91. data/lib/wx/doc/gen/defs.rb +1 -1
  92. data/lib/wx/doc/gen/dial_up_event.rb +1 -1
  93. data/lib/wx/doc/gen/dial_up_manager.rb +1 -1
  94. data/lib/wx/doc/gen/dialog.rb +1 -2
  95. data/lib/wx/doc/gen/dir_dialog.rb +1 -1
  96. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +1 -1
  97. data/lib/wx/doc/gen/dir_picker_ctrl.rb +1 -1
  98. data/lib/wx/doc/gen/drag_drop.rb +1 -1
  99. data/lib/wx/doc/gen/drag_image.rb +1 -1
  100. data/lib/wx/doc/gen/editable_list_box.rb +1 -1
  101. data/lib/wx/doc/gen/event.rb +1 -1
  102. data/lib/wx/doc/gen/event_blocker.rb +1 -1
  103. data/lib/wx/doc/gen/event_filter.rb +1 -1
  104. data/lib/wx/doc/gen/events.rb +3 -25
  105. data/lib/wx/doc/gen/evt_handler.rb +1 -1
  106. data/lib/wx/doc/gen/ext_help_controller.rb +1 -1
  107. data/lib/wx/doc/gen/file_ctrl.rb +1 -1
  108. data/lib/wx/doc/gen/file_ctrl_event.rb +1 -1
  109. data/lib/wx/doc/gen/file_dialog.rb +1 -3
  110. data/lib/wx/doc/gen/file_dialog_custom_control.rb +1 -1
  111. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +54 -62
  112. data/lib/wx/doc/gen/file_dir_picker_event.rb +1 -1
  113. data/lib/wx/doc/gen/file_picker_ctrl.rb +1 -1
  114. data/lib/wx/doc/gen/file_system.rb +2 -59
  115. data/lib/wx/doc/gen/find_dialog_event.rb +1 -1
  116. data/lib/wx/doc/gen/find_replace_data.rb +1 -1
  117. data/lib/wx/doc/gen/find_replace_dialog.rb +1 -1
  118. data/lib/wx/doc/gen/flex_grid_sizer.rb +1 -1
  119. data/lib/wx/doc/gen/font.rb +1 -1
  120. data/lib/wx/doc/gen/font_data.rb +1 -1
  121. data/lib/wx/doc/gen/font_dialog.rb +1 -1
  122. data/lib/wx/doc/gen/font_picker_ctrl.rb +1 -1
  123. data/lib/wx/doc/gen/font_picker_event.rb +1 -1
  124. data/lib/wx/doc/gen/frame.rb +1 -2
  125. data/lib/wx/doc/gen/fs_file.rb +1 -1
  126. data/lib/wx/doc/gen/functions.rb +1 -1
  127. data/lib/wx/doc/gen/gauge.rb +1 -1
  128. data/lib/wx/doc/gen/gb_sizer_item.rb +1 -1
  129. data/lib/wx/doc/gen/gcdc.rb +1 -1
  130. data/lib/wx/doc/gen/gdi_common.rb +3 -3
  131. data/lib/wx/doc/gen/gdi_object.rb +1 -1
  132. data/lib/wx/doc/gen/generic_dir_ctrl.rb +1 -1
  133. data/lib/wx/doc/gen/graphics_context.rb +1 -1
  134. data/lib/wx/doc/gen/graphics_object.rb +1 -1
  135. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +28 -24
  136. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +251 -247
  137. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +25 -21
  138. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +27 -23
  139. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +38 -34
  140. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +25 -21
  141. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +35 -31
  142. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +28 -24
  143. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +34 -30
  144. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +30 -26
  145. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +183 -179
  146. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +29 -25
  147. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +33 -29
  148. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +34 -30
  149. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +67 -63
  150. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +34 -30
  151. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +25 -21
  152. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +93 -89
  153. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +25 -21
  154. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +38 -34
  155. data/lib/wx/doc/gen/grid/grid_ctrl.rb +2716 -2724
  156. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +82 -78
  157. data/lib/wx/doc/gen/grid/grid_event.rb +106 -102
  158. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +93 -89
  159. data/lib/wx/doc/gen/grid/grid_size_event.rb +70 -66
  160. data/lib/wx/doc/gen/grid/grid_string_table.rb +130 -126
  161. data/lib/wx/doc/gen/grid/grid_table_base.rb +303 -299
  162. data/lib/wx/doc/gen/grid/grid_table_message.rb +70 -66
  163. data/lib/wx/doc/gen/grid_bag_sizer.rb +1 -1
  164. data/lib/wx/doc/gen/grid_sizer.rb +1 -1
  165. data/lib/wx/doc/gen/gui_event_loop.rb +1 -1
  166. data/lib/wx/doc/gen/header_ctrl.rb +1 -2
  167. data/lib/wx/doc/gen/header_ctrl_event.rb +1 -1
  168. data/lib/wx/doc/gen/help_controller.rb +1 -1
  169. data/lib/wx/doc/gen/help_provider.rb +1 -1
  170. data/lib/wx/doc/gen/html/html_cell.rb +515 -511
  171. data/lib/wx/doc/gen/html/html_cell_event.rb +58 -54
  172. data/lib/wx/doc/gen/html/html_easy_printing.rb +171 -167
  173. data/lib/wx/doc/gen/html/html_help_controller.rb +292 -288
  174. data/lib/wx/doc/gen/html/html_help_data.rb +147 -143
  175. data/lib/wx/doc/gen/html/html_help_window.rb +232 -228
  176. data/lib/wx/doc/gen/html/html_link_event.rb +30 -26
  177. data/lib/wx/doc/gen/html/html_list_box.rb +301 -297
  178. data/lib/wx/doc/gen/html/html_printout.rb +94 -90
  179. data/lib/wx/doc/gen/html/html_window.rb +406 -402
  180. data/lib/wx/doc/gen/hyperlink_ctrl.rb +1 -1
  181. data/lib/wx/doc/gen/hyperlink_event.rb +1 -1
  182. data/lib/wx/doc/gen/icon.rb +1 -1
  183. data/lib/wx/doc/gen/icon_location.rb +1 -1
  184. data/lib/wx/doc/gen/image.rb +1 -3
  185. data/lib/wx/doc/gen/image_list.rb +1 -1
  186. data/lib/wx/doc/gen/info_bar.rb +1 -1
  187. data/lib/wx/doc/gen/keyboard_state.rb +1 -1
  188. data/lib/wx/doc/gen/list_box.rb +1 -1
  189. data/lib/wx/doc/gen/list_ctrl.rb +1 -2
  190. data/lib/wx/doc/gen/list_event.rb +1 -1
  191. data/lib/wx/doc/gen/listbook.rb +1 -1
  192. data/lib/wx/doc/gen/locale.rb +1 -1
  193. data/lib/wx/doc/gen/log.rb +1 -1
  194. data/lib/wx/doc/gen/mdi_client_window.rb +1 -1
  195. data/lib/wx/doc/gen/mdi_frame.rb +1 -1
  196. data/lib/wx/doc/gen/media_ctrl.rb +1 -7
  197. data/lib/wx/doc/gen/media_event.rb +1 -1
  198. data/lib/wx/doc/gen/memory_dc.rb +1 -1
  199. data/lib/wx/doc/gen/menu.rb +1 -3
  200. data/lib/wx/doc/gen/menu_bar.rb +1 -1
  201. data/lib/wx/doc/gen/menu_item.rb +1 -1
  202. data/lib/wx/doc/gen/message_dialog.rb +1 -1
  203. data/lib/wx/doc/gen/mini_frame.rb +1 -1
  204. data/lib/wx/doc/gen/mirror_dc.rb +1 -1
  205. data/lib/wx/doc/gen/mouse_state.rb +1 -1
  206. data/lib/wx/doc/gen/multi_choice_dialog.rb +1 -1
  207. data/lib/wx/doc/gen/non_owned_window.rb +1 -1
  208. data/lib/wx/doc/gen/notebook.rb +1 -2
  209. data/lib/wx/doc/gen/num_validator.rb +1 -1
  210. data/lib/wx/doc/gen/number_entry_dialog.rb +1 -1
  211. data/lib/wx/doc/gen/object.rb +1 -1
  212. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +1 -1
  213. data/lib/wx/doc/gen/paint_dc.rb +1 -1
  214. data/lib/wx/doc/gen/palette.rb +1 -1
  215. data/lib/wx/doc/gen/panel.rb +1 -1
  216. data/lib/wx/doc/gen/pen.rb +1 -1
  217. data/lib/wx/doc/gen/persistence_manager.rb +1 -1
  218. data/lib/wx/doc/gen/persistent_object.rb +1 -1
  219. data/lib/wx/doc/gen/persistent_window.rb +1 -1
  220. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +33 -29
  221. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +299 -295
  222. data/lib/wx/doc/gen/pg/pg_cell.rb +162 -158
  223. data/lib/wx/doc/gen/pg/pg_editor.rb +693 -689
  224. data/lib/wx/doc/gen/pg/pg_multi_button.rb +133 -129
  225. data/lib/wx/doc/gen/pg/pg_properties.rb +2662 -2658
  226. data/lib/wx/doc/gen/pg/pg_property.rb +1929 -1938
  227. data/lib/wx/doc/gen/pg/pg_validation_info.rb +275 -273
  228. data/lib/wx/doc/gen/pg/property_grid.rb +708 -706
  229. data/lib/wx/doc/gen/pg/property_grid_event.rb +168 -164
  230. data/lib/wx/doc/gen/pg/property_grid_interface.rb +1071 -1067
  231. data/lib/wx/doc/gen/pg/property_grid_manager.rb +386 -384
  232. data/lib/wx/doc/gen/pg/property_grid_page.rb +267 -265
  233. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +147 -144
  234. data/lib/wx/doc/gen/picker_base.rb +1 -1
  235. data/lib/wx/doc/gen/platform_info.rb +1 -1
  236. data/lib/wx/doc/gen/popup_window.rb +1 -1
  237. data/lib/wx/doc/gen/progress_dialog.rb +1 -1
  238. data/lib/wx/doc/gen/property_sheet_dialog.rb +1 -1
  239. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +32 -28
  240. data/lib/wx/doc/gen/prt/post_script_dc.rb +21 -18
  241. data/lib/wx/doc/gen/prt/preview_frame.rb +49 -45
  242. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +126 -122
  243. data/lib/wx/doc/gen/prt/print_data.rb +637 -633
  244. data/lib/wx/doc/gen/prt/print_dialog.rb +43 -39
  245. data/lib/wx/doc/gen/prt/printer.rb +484 -480
  246. data/lib/wx/doc/gen/prt/printer_dc.rb +26 -22
  247. data/lib/wx/doc/gen/query_layout_info_event.rb +1 -1
  248. data/lib/wx/doc/gen/radio_box.rb +1 -1
  249. data/lib/wx/doc/gen/radio_button.rb +1 -1
  250. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +1716 -1712
  251. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +239 -235
  252. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +34 -30
  253. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +439 -435
  254. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +52 -48
  255. data/lib/wx/doc/gen/rbn/ribbon_control.rb +116 -112
  256. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +205 -201
  257. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +44 -40
  258. data/lib/wx/doc/gen/rbn/ribbon_page.rb +129 -125
  259. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +229 -225
  260. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +34 -30
  261. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +329 -325
  262. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +31 -27
  263. data/lib/wx/doc/gen/rearrange_ctrl.rb +1 -1
  264. data/lib/wx/doc/gen/rearrange_list.rb +1 -1
  265. data/lib/wx/doc/gen/region.rb +1 -1
  266. data/lib/wx/doc/gen/region_iterator.rb +1 -1
  267. data/lib/wx/doc/gen/rtc/rich_text_box.rb +424 -420
  268. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +1148 -1144
  269. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +30 -26
  270. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +516 -512
  271. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +1991 -1987
  272. data/lib/wx/doc/gen/rtc/rich_text_event.rb +159 -155
  273. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +167 -163
  274. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +271 -267
  275. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +171 -167
  276. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +88 -85
  277. data/lib/wx/doc/gen/rtc/rich_text_image.rb +323 -319
  278. data/lib/wx/doc/gen/rtc/rich_text_object.rb +2819 -2815
  279. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +1187 -1183
  280. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +242 -238
  281. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +286 -279
  282. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +181 -177
  283. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +47 -44
  284. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +145 -141
  285. data/lib/wx/doc/gen/sash_event.rb +1 -1
  286. data/lib/wx/doc/gen/sash_layout_window.rb +1 -1
  287. data/lib/wx/doc/gen/sash_window.rb +1 -1
  288. data/lib/wx/doc/gen/scaled_dc.rb +1 -1
  289. data/lib/wx/doc/gen/screen_dc.rb +1 -1
  290. data/lib/wx/doc/gen/scroll_bar.rb +1 -2
  291. data/lib/wx/doc/gen/scrolled_canvas.rb +1 -1
  292. data/lib/wx/doc/gen/scrolled_control.rb +1 -1
  293. data/lib/wx/doc/gen/scrolled_window.rb +1 -1
  294. data/lib/wx/doc/gen/search_ctrl.rb +1 -1
  295. data/lib/wx/doc/gen/simplebook.rb +1 -1
  296. data/lib/wx/doc/gen/single_choice_dialog.rb +1 -1
  297. data/lib/wx/doc/gen/sizer.rb +1 -2
  298. data/lib/wx/doc/gen/sizer_item.rb +1 -1
  299. data/lib/wx/doc/gen/slider.rb +1 -2
  300. data/lib/wx/doc/gen/spin_button.rb +1 -1
  301. data/lib/wx/doc/gen/spin_ctrl.rb +1 -1
  302. data/lib/wx/doc/gen/spin_ctrl_double.rb +1 -1
  303. data/lib/wx/doc/gen/spin_double_event.rb +1 -1
  304. data/lib/wx/doc/gen/spin_event.rb +1 -1
  305. data/lib/wx/doc/gen/splash_screen.rb +2 -2
  306. data/lib/wx/doc/gen/splitter_event.rb +1 -1
  307. data/lib/wx/doc/gen/splitter_window.rb +1 -1
  308. data/lib/wx/doc/gen/static_bitmap.rb +1 -1
  309. data/lib/wx/doc/gen/static_box.rb +1 -1
  310. data/lib/wx/doc/gen/static_box_sizer.rb +1 -1
  311. data/lib/wx/doc/gen/static_line.rb +1 -1
  312. data/lib/wx/doc/gen/static_text.rb +1 -1
  313. data/lib/wx/doc/gen/status_bar.rb +1 -1
  314. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +4202 -4199
  315. data/lib/wx/doc/gen/stc/styled_text_event.rb +7511 -7508
  316. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +1 -1
  317. data/lib/wx/doc/gen/svg_file_dc.rb +1 -1
  318. data/lib/wx/doc/gen/system_options.rb +1 -1
  319. data/lib/wx/doc/gen/system_settings.rb +1 -1
  320. data/lib/wx/doc/gen/task_bar_button.rb +1 -1
  321. data/lib/wx/doc/gen/task_bar_icon.rb +1 -2
  322. data/lib/wx/doc/gen/task_bar_icon_event.rb +1 -1
  323. data/lib/wx/doc/gen/text_attr.rb +1 -1
  324. data/lib/wx/doc/gen/text_ctrl.rb +1 -6
  325. data/lib/wx/doc/gen/text_entry.rb +1 -1
  326. data/lib/wx/doc/gen/text_entry_dialog.rb +1 -1
  327. data/lib/wx/doc/gen/text_validator.rb +1 -1
  328. data/lib/wx/doc/gen/time_picker_ctrl.rb +1 -1
  329. data/lib/wx/doc/gen/timer.rb +1 -1
  330. data/lib/wx/doc/gen/timer_event.rb +1 -1
  331. data/lib/wx/doc/gen/tip_provider.rb +1 -1
  332. data/lib/wx/doc/gen/toggle_button.rb +1 -1
  333. data/lib/wx/doc/gen/tool_bar.rb +1 -1
  334. data/lib/wx/doc/gen/tool_tip.rb +1 -1
  335. data/lib/wx/doc/gen/toolbook.rb +1 -1
  336. data/lib/wx/doc/gen/top_level_window.rb +1 -1
  337. data/lib/wx/doc/gen/tree_ctrl.rb +1 -3
  338. data/lib/wx/doc/gen/tree_event.rb +1 -1
  339. data/lib/wx/doc/gen/treebook.rb +1 -1
  340. data/lib/wx/doc/gen/ui_action_simulator.rb +1 -1
  341. data/lib/wx/doc/gen/utils.rb +1 -1
  342. data/lib/wx/doc/gen/v_list_box.rb +1 -1
  343. data/lib/wx/doc/gen/v_scrolled_window.rb +1 -2
  344. data/lib/wx/doc/gen/validator.rb +1 -1
  345. data/lib/wx/doc/gen/variant.rb +1 -1
  346. data/lib/wx/doc/gen/window.rb +1 -1
  347. data/lib/wx/doc/gen/window_dc.rb +1 -1
  348. data/lib/wx/doc/gen/window_disabler.rb +1 -1
  349. data/lib/wx/doc/gen/with_images.rb +1 -1
  350. data/lib/wx/doc/gen/wizard.rb +1 -2
  351. data/lib/wx/doc/gen/wizard_event.rb +1 -1
  352. data/lib/wx/doc/gen/wizard_page.rb +1 -2
  353. data/lib/wx/doc/gen/wizard_page_simple.rb +1 -1
  354. data/lib/wx/doc/gen/wrap_sizer.rb +1 -1
  355. data/lib/wx/doc/gen/xml_node.rb +1 -1
  356. data/lib/wx/doc/gen/xml_resource.rb +1 -1
  357. data/lib/wx/doc/owner_drawn_combobox.rb +5 -1
  358. data/lib/wx/rtc/ext/rich_text_ctrl.rb +5 -5
  359. data/lib/wx/version.rb +1 -1
  360. data/lib/wx/wxruby/base.rb +6 -4
  361. data/lib/wx/wxruby/cmd/sampler.rb +39 -29
  362. data/lib/wx/wxruby/cmd/setup.rb +122 -0
  363. data/lib/wx/wxruby/cmd/test.rb +56 -6
  364. data/lib/wxruby_aui.so +0 -0
  365. data/lib/wxruby_core.so +0 -0
  366. data/lib/wxruby_grid.so +0 -0
  367. data/lib/wxruby_html.so +0 -0
  368. data/lib/wxruby_pg.so +0 -0
  369. data/lib/wxruby_prt.so +0 -0
  370. data/lib/wxruby_rbn.so +0 -0
  371. data/lib/wxruby_rtc.so +0 -0
  372. data/lib/wxruby_stc.so +0 -0
  373. data/rakelib/install.rb +2 -0
  374. data/rakelib/lib/config/linux.rb +24 -2
  375. data/rakelib/lib/config/macosx.rb +16 -0
  376. data/rakelib/lib/config/mingw.rb +133 -9
  377. data/rakelib/lib/config/pkgman/arch.rb +53 -0
  378. data/rakelib/lib/config/pkgman/base.rb +169 -0
  379. data/rakelib/lib/config/pkgman/debian.rb +66 -0
  380. data/rakelib/lib/config/pkgman/macosx.rb +183 -0
  381. data/rakelib/lib/config/pkgman/rhel.rb +54 -0
  382. data/rakelib/lib/config/pkgman/suse.rb +54 -0
  383. data/rakelib/lib/config/unixish.rb +36 -19
  384. data/rakelib/lib/config.rb +254 -61
  385. data/rakelib/prepost.rake +9 -4
  386. data/rakelib/yard/templates/default/fulldoc/html/css/wxruby3.css +14 -0
  387. data/rakelib/yard/templates/default/fulldoc/html/setup.rb +5 -5
  388. data/rakelib/yard/yard/relative_markdown_links.rb +7 -1
  389. data/tests/test_combo_ctrl.rb +196 -0
  390. metadata +25 -4
@@ -6,1212 +6,1216 @@
6
6
 
7
7
  module Wx::RTC
8
8
 
9
- # This class knows how to lay out paragraphs.
10
- #
11
- # Category: Rich Text
12
- # @see Wx::RTC::RichTextCompositeObject
13
- # @see Wx::RTC::RichTextObject
14
- # @see Wx::RTC::RichTextBuffer
15
- # @see Wx::RTC::RichTextCtrl
16
- #
17
- #
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 RichTextParagraphLayoutBox < RichTextCompositeObject
22
-
23
- # @overload initialize(parent=nil)
24
- # @param parent [Wx::RTC::RichTextObject]
25
- # @return [Wx::RTC::RichTextParagraphLayoutBox]
26
- # @overload initialize(obj)
27
- # @param obj [Wx::RTC::RichTextParagraphLayoutBox]
28
- # @return [Wx::RTC::RichTextParagraphLayoutBox]
29
- def initialize(*args) end
30
-
31
- # Hit-testing: returns a flag indicating hit test details, plus information about position.
9
+ module Wx::RTC
10
+
11
+ # This class knows how to lay out paragraphs.
32
12
  #
33
- # 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.
34
- # 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).
35
- # One of the {Wx::RTC::RichTextHitTestFlags} values.
36
- # @param dc [Wx::DC]
37
- # @param context [Wx::RTC::RichTextDrawingContext]
38
- # @param pt [Array(Integer, Integer), Wx::Point]
39
- # @param textPosition [Integer]
40
- # @param flags [Integer]
41
- # @return [Array(Integer,Integer,Wx::RTC::RichTextObject,Wx::RTC::RichTextObject)]
42
- def hit_test(dc, context, pt, textPosition, flags=0) end
43
-
44
- # Draw the item, within the given range.
13
+ # Category: Rich Text
14
+ # @see Wx::RTC::RichTextCompositeObject
15
+ # @see Wx::RTC::RichTextObject
16
+ # @see Wx::RTC::RichTextBuffer
17
+ # @see Wx::RTC::RichTextCtrl
45
18
  #
46
- # Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)
47
- # @param dc [Wx::DC]
48
- # @param context [Wx::RTC::RichTextDrawingContext]
49
- # @param range [Range]
50
- # @param selection [Wx::RTC::RichTextSelection]
51
- # @param rect [Wx::Rect]
52
- # @param descent [Integer]
53
- # @param style [Integer]
54
- # @return [Boolean]
55
- def draw(dc, context, range, selection, rect, descent, style) end
56
-
57
- # Lay the item out at the specified position with the given size constraint.
58
19
  #
59
- # 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).
60
- # @param dc [Wx::DC]
61
- # @param context [Wx::RTC::RichTextDrawingContext]
62
- # @param rect [Wx::Rect]
63
- # @param parentRect [Wx::Rect]
64
- # @param style [Integer]
65
- # @return [Boolean]
66
- def layout(dc, context, rect, parentRect, style) end
67
-
68
- # Returns the object size for the given range.
69
20
  #
70
- # Returns false if the range is invalid for this object.
71
- # @param range [Range]
72
- # @param size [Array(Integer, Integer), Wx::Size]
73
- # @param descent [int]
74
- # @param dc [Wx::DC]
75
- # @param context [Wx::RTC::RichTextDrawingContext]
76
- # @param flags [Integer]
77
- # @param position [Array(Integer, Integer), Wx::Point]
78
- # @param parentSize [Array(Integer, Integer), Wx::Size]
79
- # @param partialExtents [Array,nil]
80
- # @return [Boolean]
81
- def get_range_size(range, size, descent, dc, context, flags, position=(Wx::Point.new(0, 0)), parentSize=Wx::DEFAULT_SIZE, partialExtents=nil) end
82
- alias_method :range_size, :get_range_size
83
-
84
- # Deletes the given range.
85
- # @param range [Range]
86
- # @return [Boolean]
87
- def delete_range(range) end
88
-
89
- # Returns any text in this object for the given range.
90
- # @param range [Range]
91
- # @return [String]
92
- def get_text_for_range(range) end
93
- alias_method :text_for_range, :get_text_for_range
94
-
95
- # Imports this object from XML.
96
- # @param buffer [Wx::RTC::RichTextBuffer]
97
- # @param node [Wx::XmlNode]
98
- # @param handler [Wx::RTC::RichTextXMLHandler]
99
- # @param recurse [Boolean]
100
- # @return [Array(Boolean,Boolean)]
101
- def import_from_xml(buffer, node, handler, recurse) end
102
-
103
- # Returns the XML node name of this object.
104
- #
105
- # This must be overridden for {Wx::XmlNode}-base XML export to work.
106
- # @return [String]
107
- def get_xml_node_name; end
108
- alias_method :xml_node_name, :get_xml_node_name
109
-
110
- # Returns true if objects of this class can accept the focus, i.e. a call to SetFocusObject is possible.
21
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
22
+ # @wxrb_require USE_RICHTEXT
23
+ class RichTextParagraphLayoutBox < RichTextCompositeObject
24
+
25
+ # @overload initialize(parent=nil)
26
+ # @param parent [Wx::RTC::RichTextObject]
27
+ # @return [Wx::RTC::RichTextParagraphLayoutBox]
28
+ # @overload initialize(obj)
29
+ # @param obj [Wx::RTC::RichTextParagraphLayoutBox]
30
+ # @return [Wx::RTC::RichTextParagraphLayoutBox]
31
+ def initialize(*args) end
32
+
33
+ # Hit-testing: returns a flag indicating hit test details, plus information about position.
34
+ #
35
+ # 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.
36
+ # 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).
37
+ # One of the {Wx::RTC::RichTextHitTestFlags} values.
38
+ # @param dc [Wx::DC]
39
+ # @param context [Wx::RTC::RichTextDrawingContext]
40
+ # @param pt [Array(Integer, Integer), Wx::Point]
41
+ # @param textPosition [Integer]
42
+ # @param flags [Integer]
43
+ # @return [Array(Integer,Integer,Wx::RTC::RichTextObject,Wx::RTC::RichTextObject)]
44
+ def hit_test(dc, context, pt, textPosition, flags=0) end
45
+
46
+ # Draw the item, within the given range.
47
+ #
48
+ # Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)
49
+ # @param dc [Wx::DC]
50
+ # @param context [Wx::RTC::RichTextDrawingContext]
51
+ # @param range [Range]
52
+ # @param selection [Wx::RTC::RichTextSelection]
53
+ # @param rect [Wx::Rect]
54
+ # @param descent [Integer]
55
+ # @param style [Integer]
56
+ # @return [Boolean]
57
+ def draw(dc, context, range, selection, rect, descent, style) end
58
+
59
+ # Lay the item out at the specified position with the given size constraint.
60
+ #
61
+ # 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).
62
+ # @param dc [Wx::DC]
63
+ # @param context [Wx::RTC::RichTextDrawingContext]
64
+ # @param rect [Wx::Rect]
65
+ # @param parentRect [Wx::Rect]
66
+ # @param style [Integer]
67
+ # @return [Boolean]
68
+ def layout(dc, context, rect, parentRect, style) end
69
+
70
+ # Returns the object size for the given range.
71
+ #
72
+ # Returns false if the range is invalid for this object.
73
+ # @param range [Range]
74
+ # @param size [Array(Integer, Integer), Wx::Size]
75
+ # @param descent [int]
76
+ # @param dc [Wx::DC]
77
+ # @param context [Wx::RTC::RichTextDrawingContext]
78
+ # @param flags [Integer]
79
+ # @param position [Array(Integer, Integer), Wx::Point]
80
+ # @param parentSize [Array(Integer, Integer), Wx::Size]
81
+ # @param partialExtents [Array,nil]
82
+ # @return [Boolean]
83
+ def get_range_size(range, size, descent, dc, context, flags, position=(Wx::Point.new(0, 0)), parentSize=Wx::DEFAULT_SIZE, partialExtents=nil) end
84
+ alias_method :range_size, :get_range_size
85
+
86
+ # Deletes the given range.
87
+ # @param range [Range]
88
+ # @return [Boolean]
89
+ def delete_range(range) end
90
+
91
+ # Returns any text in this object for the given range.
92
+ # @param range [Range]
93
+ # @return [String]
94
+ def get_text_for_range(range) end
95
+ alias_method :text_for_range, :get_text_for_range
96
+
97
+ # Imports this object from XML.
98
+ # @param buffer [Wx::RTC::RichTextBuffer]
99
+ # @param node [Wx::XmlNode]
100
+ # @param handler [Wx::RTC::RichTextXMLHandler]
101
+ # @param recurse [Boolean]
102
+ # @return [Array(Boolean,Boolean)]
103
+ def import_from_xml(buffer, node, handler, recurse) end
104
+
105
+ # Returns the XML node name of this object.
106
+ #
107
+ # This must be overridden for {Wx::XmlNode}-base XML export to work.
108
+ # @return [String]
109
+ def get_xml_node_name; end
110
+ alias_method :xml_node_name, :get_xml_node_name
111
+
112
+ # Returns true if objects of this class can accept the focus, i.e. a call to SetFocusObject is possible.
113
+ #
114
+ # For example, containers supporting text, such as a text box object, can accept the focus, but a table can't (set the focus to individual cells instead).
115
+ # @return [Boolean]
116
+ def accepts_focus; end
117
+
118
+ # Associates a control with the buffer, for operations that for example require refreshing the window.
119
+ # @param ctrl [Wx::RTC::RichTextCtrl]
120
+ # @return [void]
121
+ def set_rich_text_ctrl(ctrl) end
122
+ alias_method :rich_text_ctrl=, :set_rich_text_ctrl
123
+
124
+ # Returns the associated control.
125
+ # @return [Wx::RTC::RichTextCtrl]
126
+ def get_rich_text_ctrl; end
127
+ alias_method :rich_text_ctrl, :get_rich_text_ctrl
128
+
129
+ # Sets a flag indicating whether the last paragraph is partial or complete.
130
+ # @param partialPara [Boolean]
131
+ # @return [void]
132
+ def set_partial_paragraph(partialPara) end
133
+ alias_method :partial_paragraph=, :set_partial_paragraph
134
+
135
+ # Returns a flag indicating whether the last paragraph is partial or complete.
136
+ # @return [Boolean]
137
+ def get_partial_paragraph; end
138
+ alias_method :partial_paragraph, :get_partial_paragraph
139
+
140
+ # Returns the style sheet associated with the overall buffer.
141
+ # @return [Wx::RTC::RichTextStyleSheet]
142
+ def get_style_sheet; end
143
+ alias_method :style_sheet, :get_style_sheet
144
+
145
+ # Returns true if this object is top-level, i.e. contains its own paragraphs, such as a text box.
146
+ # @return [Boolean]
147
+ def is_top_level; end
148
+ alias_method :top_level?, :is_top_level
149
+
150
+ # Submits a command to insert paragraphs.
151
+ # @param buffer [Wx::RTC::RichTextBuffer]
152
+ # @param pos [Integer]
153
+ # @param paragraphs [Wx::RTC::RichTextParagraphLayoutBox]
154
+ # @param ctrl [Wx::RTC::RichTextCtrl]
155
+ # @param flags [Integer]
156
+ # @return [Boolean]
157
+ def insert_paragraphs_with_undo(buffer, pos, paragraphs, ctrl, flags=0) end
158
+
159
+ # Submits a command to insert the given text.
160
+ # @param buffer [Wx::RTC::RichTextBuffer]
161
+ # @param pos [Integer]
162
+ # @param text [String]
163
+ # @param ctrl [Wx::RTC::RichTextCtrl]
164
+ # @param flags [Integer]
165
+ # @return [Boolean]
166
+ def insert_text_with_undo(buffer, pos, text, ctrl, flags=0) end
167
+
168
+ # Submits a command to insert the given text.
169
+ # @param buffer [Wx::RTC::RichTextBuffer]
170
+ # @param pos [Integer]
171
+ # @param ctrl [Wx::RTC::RichTextCtrl]
172
+ # @param flags [Integer]
173
+ # @return [Boolean]
174
+ def insert_newline_with_undo(buffer, pos, ctrl, flags=0) end
175
+
176
+ # Submits a command to insert the given image.
177
+ # @param buffer [Wx::RTC::RichTextBuffer]
178
+ # @param pos [Integer]
179
+ # @param imageBlock [Wx::RTC::RichTextImageBlock]
180
+ # @param ctrl [Wx::RTC::RichTextCtrl]
181
+ # @param flags [Integer]
182
+ # @param textAttr [Wx::RTC::RichTextAttr]
183
+ # @return [Boolean]
184
+ def insert_image_with_undo(buffer, pos, imageBlock, ctrl, flags, textAttr) end
185
+
186
+ # Submits a command to insert the given field.
187
+ #
188
+ # Field data can be included in properties.
189
+ # @see Wx::RTC::RichTextField
190
+ # @see Wx::RTC::RichTextFieldType
191
+ # @see Wx::RTC::RichTextFieldTypeStandard
192
+ # @param buffer [Wx::RTC::RichTextBuffer]
193
+ # @param pos [Integer]
194
+ # @param fieldType [String]
195
+ # @param properties [Wx::RTC::RichTextProperties]
196
+ # @param ctrl [Wx::RTC::RichTextCtrl]
197
+ # @param flags [Integer]
198
+ # @param textAttr [Wx::RTC::RichTextAttr]
199
+ # @return [Wx::RTC::RichTextField]
200
+ def insert_field_with_undo(buffer, pos, fieldType, properties, ctrl, flags, textAttr) end
201
+
202
+ # Returns the style that is appropriate for a new paragraph at this position.
203
+ #
204
+ # If the previous paragraph has a paragraph style name, looks up the next-paragraph style.
205
+ # @param buffer [Wx::RTC::RichTextBuffer]
206
+ # @param pos [Integer]
207
+ # @param caretPosition [Boolean]
208
+ # @param lookUpNewParaStyle [Boolean]
209
+ # @return [Wx::RTC::RichTextAttr]
210
+ def get_style_for_new_paragraph(buffer, pos, caretPosition=false, lookUpNewParaStyle=false) end
211
+ alias_method :style_for_new_paragraph, :get_style_for_new_paragraph
212
+
213
+ # Inserts an object.
214
+ # @param buffer [Wx::RTC::RichTextBuffer]
215
+ # @param pos [Integer]
216
+ # @param object [Wx::RTC::RichTextObject]
217
+ # @param ctrl [Wx::RTC::RichTextCtrl]
218
+ # @param flags [Integer]
219
+ # @return [Wx::RTC::RichTextObject]
220
+ def insert_object_with_undo(buffer, pos, object, ctrl, flags=0) end
221
+
222
+ # Submits a command to delete this range.
223
+ # @param range [Range]
224
+ # @param ctrl [Wx::RTC::RichTextCtrl]
225
+ # @param buffer [Wx::RTC::RichTextBuffer]
226
+ # @return [Boolean]
227
+ def delete_range_with_undo(range, ctrl, buffer) end
228
+
229
+ # Draws the floating objects in this buffer.
230
+ # @param dc [Wx::DC]
231
+ # @param context [Wx::RTC::RichTextDrawingContext]
232
+ # @param range [Range]
233
+ # @param selection [Wx::RTC::RichTextSelection]
234
+ # @param rect [Wx::Rect]
235
+ # @param descent [Integer]
236
+ # @param style [Integer]
237
+ # @return [void]
238
+ def draw_floats(dc, context, range, selection, rect, descent, style) end
239
+
240
+ # Moves an anchored object to another paragraph.
241
+ # @param from [Wx::RTC::RichTextParagraph]
242
+ # @param to [Wx::RTC::RichTextParagraph]
243
+ # @param obj [Wx::RTC::RichTextObject]
244
+ # @return [void]
245
+ def move_anchored_object_to_paragraph(from, to, obj) end
246
+
247
+ # Initializes the object.
248
+ # @return [void]
249
+ def init; end
250
+
251
+ # Clears all the children.
252
+ # @return [void]
253
+ def clear; end
254
+
255
+ # Clears and initializes with one blank paragraph.
256
+ # @return [void]
257
+ def reset; end
258
+
259
+ # Convenience function to add a paragraph of text.
260
+ # @param text [String]
261
+ # @param paraStyle [Wx::RTC::RichTextAttr]
262
+ # @return [Range]
263
+ def add_paragraph(text, paraStyle=nil) end
264
+
265
+ # Convenience function to add an image.
266
+ # @param image [Wx::Image]
267
+ # @param paraStyle [Wx::RTC::RichTextAttr]
268
+ # @return [Range]
269
+ def add_image(image, paraStyle=nil) end
270
+
271
+ # Adds multiple paragraphs, based on newlines.
272
+ # @param text [String]
273
+ # @param paraStyle [Wx::RTC::RichTextAttr]
274
+ # @return [Range]
275
+ def add_paragraphs(text, paraStyle=nil) end
276
+
277
+ # Returns the line at the given position.
278
+ #
279
+ # If caretPosition is true, the position is a caret position, which is normally a smaller number.
280
+ # @param pos [Integer]
281
+ # @param caretPosition [Boolean]
282
+ # @return [Wx::RTC::RichTextLine]
283
+ def get_line_at_position(pos, caretPosition=false) end
284
+ alias_method :line_at_position, :get_line_at_position
285
+
286
+ # Returns the line at the given y pixel position, or the last line.
287
+ # @param y [Integer]
288
+ # @return [Wx::RTC::RichTextLine]
289
+ def get_line_at_y_position(y) end
290
+ alias_method :line_at_y_position, :get_line_at_y_position
291
+
292
+ # Returns the paragraph at the given character or caret position.
293
+ # @param pos [Integer]
294
+ # @param caretPosition [Boolean]
295
+ # @return [Wx::RTC::RichTextParagraph]
296
+ def get_paragraph_at_position(pos, caretPosition=false) end
297
+ alias_method :paragraph_at_position, :get_paragraph_at_position
298
+
299
+ # Returns the line size at the given position.
300
+ # @param pos [Integer]
301
+ # @param caretPosition [Boolean]
302
+ # @return [Wx::Size]
303
+ def get_line_size_at_position(pos, caretPosition=false) end
304
+ alias_method :line_size_at_position, :get_line_size_at_position
305
+
306
+ # Given a position, returns the number of the visible line (potentially many to a paragraph), starting from zero at the start of the buffer.
307
+ #
308
+ # We also have to pass a bool (startOfLine) that indicates whether the caret is being shown at the end of the previous line or at the start of the next, since the caret can be shown at two visible positions for the same underlying position.
309
+ # @param pos [Integer]
310
+ # @param caretPosition [Boolean]
311
+ # @param startOfLine [Boolean]
312
+ # @return [Integer]
313
+ def get_visible_line_number(pos, caretPosition=false, startOfLine=false) end
314
+ alias_method :visible_line_number, :get_visible_line_number
315
+
316
+ # Given a line number, returns the corresponding {Wx::RTC::RichTextLine} object.
317
+ # @param lineNumber [Integer]
318
+ # @return [Wx::RTC::RichTextLine]
319
+ def get_line_for_visible_line_number(lineNumber) end
320
+ alias_method :line_for_visible_line_number, :get_line_for_visible_line_number
321
+
322
+ # Returns the leaf object in a paragraph at this position.
323
+ # @param position [Integer]
324
+ # @return [Wx::RTC::RichTextObject]
325
+ def get_leaf_object_at_position(position) end
326
+ alias_method :leaf_object_at_position, :get_leaf_object_at_position
327
+
328
+ # Returns the paragraph by number.
329
+ # @param paragraphNumber [Integer]
330
+ # @return [Wx::RTC::RichTextParagraph]
331
+ def get_paragraph_at_line(paragraphNumber) end
332
+ alias_method :paragraph_at_line, :get_paragraph_at_line
333
+
334
+ # Returns the paragraph for a given line.
335
+ # @param line [Wx::RTC::RichTextLine]
336
+ # @return [Wx::RTC::RichTextParagraph]
337
+ def get_paragraph_for_line(line) end
338
+ alias_method :paragraph_for_line, :get_paragraph_for_line
339
+
340
+ # Returns the length of the paragraph.
341
+ # @param paragraphNumber [Integer]
342
+ # @return [Integer]
343
+ def get_paragraph_length(paragraphNumber) end
344
+ alias_method :paragraph_length, :get_paragraph_length
345
+
346
+ # Returns the number of paragraphs.
347
+ # @return [Integer]
348
+ def get_paragraph_count; end
349
+ alias_method :paragraph_count, :get_paragraph_count
350
+
351
+ # Returns the number of visible lines.
352
+ # @return [Integer]
353
+ def get_line_count; end
354
+ alias_method :line_count, :get_line_count
355
+
356
+ # Returns the text of the paragraph.
357
+ # @param paragraphNumber [Integer]
358
+ # @return [String]
359
+ def get_paragraph_text(paragraphNumber) end
360
+ alias_method :paragraph_text, :get_paragraph_text
361
+
362
+ # Converts zero-based line column and paragraph number to a position.
363
+ # @param x [Integer]
364
+ # @param y [Integer]
365
+ # @return [Integer]
366
+ def xy_to_position(x, y) end
367
+
368
+ # Converts a zero-based position to line column and paragraph number.
369
+ # @param pos [Integer]
370
+ # @return [Array(Boolean,Integer,Integer)]
371
+ def position_to_xy(pos) end
372
+
373
+ # @overload set_style(range, style, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO)
374
+ # Sets the attributes for the given range.
375
+ #
376
+ # Pass flags to determine how the attributes are set.
377
+ # The end point of range is specified as the last character position of the span of text. So, for example, to set the style for a character at position 5, use the range (5,5). This differs from the {Wx::RTC::RichTextCtrl} API, where you would specify (5,6).
378
+ # flags may contain a bit list of the following values:
379
+ #
380
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_NONE}: no style flag.
381
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this operation should be undoable.
382
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_OPTIMIZE}: specifies that the style should not be applied if the combined style at this point is already the style in question.
383
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_PARAGRAPHS_ONLY}: specifies that the style should only be applied to paragraphs, and not the content. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
384
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_CHARACTERS_ONLY}: specifies that the style should only be applied to characters, and not the paragraph. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
385
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_RESET}: resets (clears) the existing style before applying the new style.
386
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_REMOVE}: removes the specified style. Only the style flags are used in this operation.
387
+ # @param range [Range]
388
+ # @param style [Wx::RTC::RichTextAttr]
389
+ # @param flags [Integer]
390
+ # @return [Boolean]
391
+ # @overload set_style(obj, textAttr, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO)
392
+ # Sets the attributes for the given object only, for example the box attributes for a text box.
393
+ # @param obj [Wx::RTC::RichTextObject]
394
+ # @param textAttr [Wx::RTC::RichTextAttr]
395
+ # @param flags [Integer]
396
+ # @return [void]
397
+ def set_style(*args) end
398
+
399
+ # Returns the combined text attributes for this position.
400
+ #
401
+ # This function gets the uncombined style - that is, the attributes associated with the paragraph or character content, and not necessarily the combined attributes you see on the screen. To get the combined attributes, use {Wx::RTC::RichTextParagraphLayoutBox#get_style}. If you specify (any) paragraph attribute in style's flags, this function will fetch the paragraph attributes. Otherwise, it will return the character attributes.
402
+ # @param position [Integer]
403
+ # @param style [Wx::RTC::RichTextAttr]
404
+ # @return [Boolean]
405
+ def get_style(position, style) end
406
+ alias_method :style, :get_style
407
+
408
+ # Returns the content (uncombined) attributes for this position.
409
+ # @param position [Integer]
410
+ # @param style [Wx::RTC::RichTextAttr]
411
+ # @return [Boolean]
412
+ def get_uncombined_style(position, style) end
413
+ alias_method :uncombined_style, :get_uncombined_style
414
+
415
+ # Implementation helper for GetStyle.
416
+ #
417
+ # If combineStyles is true, combine base, paragraph and context attributes.
418
+ # @param position [Integer]
419
+ # @param style [Wx::RTC::RichTextAttr]
420
+ # @param combineStyles [Boolean]
421
+ # @return [Boolean]
422
+ def do_get_style(position, style, combineStyles=true) end
423
+
424
+ # This function gets a style representing the common, combined attributes in the given range.
425
+ #
426
+ # Attributes which have different values within the specified range will not be included the style flags.
427
+ # The function is used to get the attributes to display in the formatting dialog: the user can edit the attributes common to the selection, and optionally specify the values of further attributes to be applied uniformly.
428
+ # To apply the edited attributes, you can use {Wx::RTC::RichTextParagraphLayoutBox#set_style} specifying the {Wx::RTC::RICHTEXT_SETSTYLE_OPTIMIZE} flag, which will only apply attributes that are different from the combined attributes within the range. So, the user edits the effective, displayed attributes for the range, but his choice won't be applied unnecessarily to content. As an example, say the style for a paragraph specifies bold, but the paragraph text doesn't specify a weight. The combined style is bold, and this is what the user will see on-screen and in the formatting dialog. The user now specifies red text, in addition to bold. When applying with {Wx::RTC::RichTextParagraphLayoutBox#set_style}, the content font weight attributes won't be changed to bold because this is already specified by the paragraph. However the text colour attributes will be changed to show red.
429
+ # @param range [Range]
430
+ # @param style [Wx::RTC::RichTextAttr]
431
+ # @return [Boolean]
432
+ def get_style_for_range(range, style) end
433
+ alias_method :style_for_range, :get_style_for_range
434
+
435
+ # Combines style with currentStyle for the purpose of summarising the attributes of a range of content.
436
+ # @param currentStyle [Wx::RTC::RichTextAttr]
437
+ # @param style [Wx::RTC::RichTextAttr]
438
+ # @param clashingAttr [Wx::RTC::RichTextAttr]
439
+ # @param absentAttr [Wx::RTC::RichTextAttr]
440
+ # @return [Boolean]
441
+ def collect_style(currentStyle, style, clashingAttr, absentAttr) end
442
+
443
+ # @overload set_list_style(range, def_, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1)
444
+ # Sets the list attributes for the given range, passing flags to determine how the attributes are set.
445
+ #
446
+ # Either the style definition or the name of the style definition (in the current sheet) can be passed.
447
+ # flags is a bit list of the following:
448
+ #
449
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this command will be undoable.
450
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_RENUMBER}: specifies that numbering should start from startFrom, otherwise existing attributes are used.
451
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_SPECIFY_LEVEL}: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.
452
+ # @see Wx::RTC::RichTextParagraphLayoutBox#number_list
453
+ # @see Wx::RTC::RichTextParagraphLayoutBox#promote_list
454
+ # @see Wx::RTC::RichTextParagraphLayoutBox#clear_list_style.
455
+ # @param range [Range]
456
+ # @param def_ [Wx::RTC::RichTextListStyleDefinition]
457
+ # @param flags [Integer]
458
+ # @param startFrom [Integer]
459
+ # @param specifiedLevel [Integer]
460
+ # @return [Boolean]
461
+ # @overload set_list_style(range, defName, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1)
462
+ # @param range [Range]
463
+ # @param defName [String]
464
+ # @param flags [Integer]
465
+ # @param startFrom [Integer]
466
+ # @param specifiedLevel [Integer]
467
+ # @return [Boolean]
468
+ def set_list_style(*args) end
469
+
470
+ # Clears the list style from the given range, clearing list-related attributes and applying any named paragraph style associated with each paragraph.
471
+ #
472
+ # flags is a bit list of the following:
473
+ #
474
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this command will be undoable.
475
+ # @see Wx::RTC::RichTextParagraphLayoutBox#set_list_style
476
+ # @see Wx::RTC::RichTextParagraphLayoutBox#promote_list
477
+ # @see Wx::RTC::RichTextParagraphLayoutBox#number_list
478
+ # @param range [Range]
479
+ # @param flags [Integer]
480
+ # @return [Boolean]
481
+ def clear_list_style(range, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO) end
482
+
483
+ # @overload number_list(range, def_=nil, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1)
484
+ # Numbers the paragraphs in the given range.
485
+ #
486
+ # Pass flags to determine how the attributes are set. Either the style definition or the name of the style definition (in the current sheet) can be passed.
487
+ # flags is a bit list of the following:
488
+ #
489
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this command will be undoable.
490
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_RENUMBER}: specifies that numbering should start from startFrom, otherwise existing attributes are used.
491
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_SPECIFY_LEVEL}: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.
492
+ #
493
+ # def can be NULL to indicate that the existing list style should be used.
494
+ # @see Wx::RTC::RichTextParagraphLayoutBox#set_list_style
495
+ # @see Wx::RTC::RichTextParagraphLayoutBox#promote_list
496
+ # @see Wx::RTC::RichTextParagraphLayoutBox#clear_list_style
497
+ # @param range [Range]
498
+ # @param def_ [Wx::RTC::RichTextListStyleDefinition]
499
+ # @param flags [Integer]
500
+ # @param startFrom [Integer]
501
+ # @param specifiedLevel [Integer]
502
+ # @return [Boolean]
503
+ # @overload number_list(range, defName, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1)
504
+ # @param range [Range]
505
+ # @param defName [String]
506
+ # @param flags [Integer]
507
+ # @param startFrom [Integer]
508
+ # @param specifiedLevel [Integer]
509
+ # @return [Boolean]
510
+ def number_list(*args) end
511
+
512
+ # @overload promote_list(promoteBy, range, def_=nil, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, specifiedLevel=-1)
513
+ # Promotes the list items within the given range.
514
+ #
515
+ # A positive promoteBy produces a smaller indent, and a negative number produces a larger indent. Pass flags to determine how the attributes are set. Either the style definition or the name of the style definition (in the current sheet) can be passed.
516
+ # flags is a bit list of the following:
517
+ #
518
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this command will be undoable.
519
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_RENUMBER}: specifies that numbering should start from startFrom, otherwise existing attributes are used.
520
+ # - {Wx::RTC::RICHTEXT_SETSTYLE_SPECIFY_LEVEL}: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.
521
+ # @see Wx::RTC::RichTextParagraphLayoutBox#set_list_style
522
+ # @see Wx::RTC::RichTextParagraphLayoutBox#set_list_style
523
+ # @see Wx::RTC::RichTextParagraphLayoutBox#clear_list_style
524
+ # @param promoteBy [Integer]
525
+ # @param range [Range]
526
+ # @param def_ [Wx::RTC::RichTextListStyleDefinition]
527
+ # @param flags [Integer]
528
+ # @param specifiedLevel [Integer]
529
+ # @return [Boolean]
530
+ # @overload promote_list(promoteBy, range, defName, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, specifiedLevel=-1)
531
+ # @param promoteBy [Integer]
532
+ # @param range [Range]
533
+ # @param defName [String]
534
+ # @param flags [Integer]
535
+ # @param specifiedLevel [Integer]
536
+ # @return [Boolean]
537
+ def promote_list(*args) end
538
+
539
+ # Helper for NumberList and PromoteList, that does renumbering and promotion simultaneously def can be NULL/empty to indicate that the existing list style should be used.
540
+ # @param range [Range]
541
+ # @param promotionRange [Range]
542
+ # @param promoteBy [Integer]
543
+ # @param def_ [Wx::RTC::RichTextListStyleDefinition]
544
+ # @param flags [Integer]
545
+ # @param startFrom [Integer]
546
+ # @param specifiedLevel [Integer]
547
+ # @return [Boolean]
548
+ def do_number_list(range, promotionRange, promoteBy, def_, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1) end
549
+
550
+ # Fills in the attributes for numbering a paragraph after previousParagraph.
551
+ # @param previousParagraph [Wx::RTC::RichTextParagraph]
552
+ # @param attr [Wx::RTC::RichTextAttr]
553
+ # @return [Boolean]
554
+ def find_next_paragraph_number(previousParagraph, attr) end
555
+
556
+ # Sets the properties for the given range, passing flags to determine how the attributes are set.
557
+ #
558
+ # You can merge properties or replace them.
559
+ # The end point of range is specified as the last character position of the span of text, plus one. So, for example, to set the properties for a character at position 5, use the range (5,6).
560
+ # flags may contain a bit list of the following values:
561
+ #
562
+ # - {Wx::RTC::RICHTEXT_SETPROPERTIES_NONE}: no flag.
563
+ # - {Wx::RTC::RICHTEXT_SETPROPERTIES_WITH_UNDO}: specifies that this operation should be undoable.
564
+ # - {Wx::RTC::RICHTEXT_SETPROPERTIES_PARAGRAPHS_ONLY}: specifies that the properties should only be applied to paragraphs, and not the content.
565
+ # - {Wx::RTC::RICHTEXT_SETPROPERTIES_CHARACTERS_ONLY}: specifies that the properties should only be applied to characters, and not the paragraph.
566
+ # - {Wx::RTC::RICHTEXT_SETPROPERTIES_RESET}: resets (clears) the existing properties before applying the new properties.
567
+ # - {Wx::RTC::RICHTEXT_SETPROPERTIES_REMOVE}: removes the specified properties.
568
+ # @param range [Range]
569
+ # @param properties [Wx::RTC::RichTextProperties]
570
+ # @param flags [Integer]
571
+ # @return [Boolean]
572
+ def set_properties(range, properties, flags=Wx::RTC::RICHTEXT_SETPROPERTIES_WITH_UNDO) end
573
+
574
+ # Sets with undo the properties for the given object.
575
+ # @param obj [Wx::RTC::RichTextObject]
576
+ # @param properties [Wx::RTC::RichTextProperties]
577
+ # @param objToSet [Wx::RTC::RichTextObject]
578
+ # @return [Boolean]
579
+ def set_object_properties_with_undo(obj, properties, objToSet=nil) end
580
+
581
+ # Test if this whole range has character attributes of the specified kind.
582
+ #
583
+ # If any of the attributes are different within the range, the test fails. You can use this to implement, for example, bold button updating. style must have flags indicating which attributes are of interest.
584
+ # @param range [Range]
585
+ # @param style [Wx::RTC::RichTextAttr]
586
+ # @return [Boolean]
587
+ def has_character_attributes(range, style) end
588
+ alias_method :has_character_attributes?, :has_character_attributes
589
+
590
+ # Test if this whole range has paragraph attributes of the specified kind.
591
+ #
592
+ # If any of the attributes are different within the range, the test fails. You can use this to implement, for example, centering button updating. style must have flags indicating which attributes are of interest.
593
+ # @param range [Range]
594
+ # @param style [Wx::RTC::RichTextAttr]
595
+ # @return [Boolean]
596
+ def has_paragraph_attributes(range, style) end
597
+ alias_method :has_paragraph_attributes?, :has_paragraph_attributes
598
+
599
+ # Clones the object.
600
+ # @return [Wx::RTC::RichTextObject]
601
+ def clone; end
602
+
603
+ # Prepares the content just before insertion (or after buffer reset).
604
+ #
605
+ # Currently is only called if undo mode is on.
606
+ # @param container [Wx::RTC::RichTextParagraphLayoutBox]
607
+ # @return [void]
608
+ def prepare_content(container) end
609
+
610
+ # Insert fragment into this box at the given position.
611
+ #
612
+ # If partialParagraph is true, it is assumed that the last (or only) paragraph is just a piece of data with no paragraph marker.
613
+ # @param position [Integer]
614
+ # @param fragment [Wx::RTC::RichTextParagraphLayoutBox]
615
+ # @return [Boolean]
616
+ def insert_fragment(position, fragment) end
617
+
618
+ # Make a copy of the fragment corresponding to the given range, putting it in fragment.
619
+ # @param range [Range]
620
+ # @param fragment [Wx::RTC::RichTextParagraphLayoutBox]
621
+ # @return [Boolean]
622
+ def copy_fragment(range, fragment) end
623
+
624
+ # Apply the style sheet to the buffer, for example if the styles have changed.
625
+ # @param styleSheet [Wx::RTC::RichTextStyleSheet]
626
+ # @return [Boolean]
627
+ def apply_style_sheet(styleSheet) end
628
+
629
+ # @param obj [Wx::RTC::RichTextParagraphLayoutBox]
630
+ # @return [void]
631
+ def copy(obj) end
632
+
633
+ # Calculate ranges.
634
+ # @return [void]
635
+ def update_ranges; end
636
+
637
+ # Get all the text.
638
+ # @return [String]
639
+ def get_text; end
640
+ alias_method :text, :get_text
641
+
642
+ # Sets the default style, affecting the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold).
643
+ #
644
+ # This is not cumulative - setting the default style will replace the previous default style.
645
+ # Setting it to a default attribute object makes new content take on the 'basic' style.
646
+ # @param style [Wx::RTC::RichTextAttr]
647
+ # @return [Boolean]
648
+ def set_default_style(style) end
649
+ alias_method :default_style=, :set_default_style
650
+
651
+ # Returns the current default style, affecting the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold).
652
+ # @return [Wx::RTC::RichTextAttr]
653
+ def get_default_style; end
654
+ alias_method :default_style, :get_default_style
655
+
656
+ # Sets the basic (overall) style.
657
+ #
658
+ # This is the style of the whole buffer before further styles are applied, unlike the default style, which only affects the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold).
659
+ # @param style [Wx::RTC::RichTextAttr]
660
+ # @return [void]
661
+ def set_basic_style(style) end
662
+ alias_method :basic_style=, :set_basic_style
663
+
664
+ # Returns the basic (overall) style.
665
+ #
666
+ # This is the style of the whole buffer before further styles are applied, unlike the default style, which only affects the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold).
667
+ # @return [Wx::RTC::RichTextAttr]
668
+ def get_basic_style; end
669
+ alias_method :basic_style, :get_basic_style
670
+
671
+ # Invalidates the buffer.
672
+ #
673
+ # With no argument, invalidates whole buffer.
674
+ # @param invalidRange [Range]
675
+ # @return [void]
676
+ def invalidate(invalidRange=Wx::RICHTEXT_ALL) end
677
+
678
+ # Do the (in)validation for this object only.
679
+ # @param invalidRange [Range]
680
+ # @return [void]
681
+ def do_invalidate(invalidRange) end
682
+
683
+ # Do the (in)validation both up and down the hierarchy.
684
+ # @param invalidRange [Range]
685
+ # @return [void]
686
+ def invalidate_hierarchy(invalidRange=Wx::RICHTEXT_ALL) end
687
+
688
+ # Gather information about floating objects.
689
+ #
690
+ # If untilObj is non-NULL, will stop getting information if the current object is this, since we will collect the rest later.
691
+ # @param availableRect [Wx::Rect]
692
+ # @param untilObj [Wx::RTC::RichTextObject]
693
+ # @return [Boolean]
694
+ def update_floating_objects(availableRect, untilObj=nil) end
695
+
696
+ # Get invalid range, rounding to entire paragraphs if argument is true.
697
+ # @param wholeParagraphs [Boolean]
698
+ # @return [Range]
699
+ def get_invalid_range(wholeParagraphs=false) end
700
+ alias_method :invalid_range, :get_invalid_range
701
+
702
+ # Returns true if this object needs layout.
703
+ # @return [Boolean]
704
+ def is_dirty; end
705
+ alias_method :dirty?, :is_dirty
706
+
707
+ # Returns the {Wx::RTC::RichTextFloatCollector} of this object.
708
+ # @return [Wx::RTC::RichTextFloatCollector]
709
+ def get_float_collector; end
710
+ alias_method :float_collector, :get_float_collector
711
+
712
+ # Returns the number of floating objects at this level.
713
+ # @return [Integer]
714
+ def get_floating_object_count; end
715
+ alias_method :floating_object_count, :get_floating_object_count
716
+
717
+ # Returns a list of floating objects.
718
+ # @param objects [Array<Wx::RTC::RichTextObject>]
719
+ # @return [Boolean]
720
+ def get_floating_objects(objects) end
721
+ alias_method :floating_objects, :get_floating_objects
722
+
723
+ end # RichTextParagraphLayoutBox
724
+
725
+ # This class implements the general concept of a field, an object that represents additional functionality such as a footnote, a bookmark, a page number, a table of contents, and so on.
111
726
  #
112
- # For example, containers supporting text, such as a text box object, can accept the focus, but a table can't (set the focus to individual cells instead).
113
- # @return [Boolean]
114
- def accepts_focus; end
115
-
116
- # Associates a control with the buffer, for operations that for example require refreshing the window.
117
- # @param ctrl [Wx::RTC::RichTextCtrl]
118
- # @return [void]
119
- def set_rich_text_ctrl(ctrl) end
120
- alias_method :rich_text_ctrl=, :set_rich_text_ctrl
121
-
122
- # Returns the associated control.
123
- # @return [Wx::RTC::RichTextCtrl]
124
- def get_rich_text_ctrl; end
125
- alias_method :rich_text_ctrl, :get_rich_text_ctrl
126
-
127
- # Sets a flag indicating whether the last paragraph is partial or complete.
128
- # @param partialPara [Boolean]
129
- # @return [void]
130
- def set_partial_paragraph(partialPara) end
131
- alias_method :partial_paragraph=, :set_partial_paragraph
132
-
133
- # Returns a flag indicating whether the last paragraph is partial or complete.
134
- # @return [Boolean]
135
- def get_partial_paragraph; end
136
- alias_method :partial_paragraph, :get_partial_paragraph
137
-
138
- # Returns the style sheet associated with the overall buffer.
139
- # @return [Wx::RTC::RichTextStyleSheet]
140
- def get_style_sheet; end
141
- alias_method :style_sheet, :get_style_sheet
142
-
143
- # Returns true if this object is top-level, i.e. contains its own paragraphs, such as a text box.
144
- # @return [Boolean]
145
- def is_top_level; end
146
- alias_method :top_level?, :is_top_level
147
-
148
- # Submits a command to insert paragraphs.
149
- # @param buffer [Wx::RTC::RichTextBuffer]
150
- # @param pos [Integer]
151
- # @param paragraphs [Wx::RTC::RichTextParagraphLayoutBox]
152
- # @param ctrl [Wx::RTC::RichTextCtrl]
153
- # @param flags [Integer]
154
- # @return [Boolean]
155
- def insert_paragraphs_with_undo(buffer, pos, paragraphs, ctrl, flags=0) end
156
-
157
- # Submits a command to insert the given text.
158
- # @param buffer [Wx::RTC::RichTextBuffer]
159
- # @param pos [Integer]
160
- # @param text [String]
161
- # @param ctrl [Wx::RTC::RichTextCtrl]
162
- # @param flags [Integer]
163
- # @return [Boolean]
164
- def insert_text_with_undo(buffer, pos, text, ctrl, flags=0) end
165
-
166
- # Submits a command to insert the given text.
167
- # @param buffer [Wx::RTC::RichTextBuffer]
168
- # @param pos [Integer]
169
- # @param ctrl [Wx::RTC::RichTextCtrl]
170
- # @param flags [Integer]
171
- # @return [Boolean]
172
- def insert_newline_with_undo(buffer, pos, ctrl, flags=0) end
173
-
174
- # Submits a command to insert the given image.
175
- # @param buffer [Wx::RTC::RichTextBuffer]
176
- # @param pos [Integer]
177
- # @param imageBlock [Wx::RTC::RichTextImageBlock]
178
- # @param ctrl [Wx::RTC::RichTextCtrl]
179
- # @param flags [Integer]
180
- # @param textAttr [Wx::RTC::RichTextAttr]
181
- # @return [Boolean]
182
- def insert_image_with_undo(buffer, pos, imageBlock, ctrl, flags, textAttr) end
183
-
184
- # Submits a command to insert the given field.
727
+ # Extra information (such as a bookmark name) can be stored in the object properties.
728
+ # Drawing, layout, and property editing is delegated to classes derived from {Wx::RTC::RichTextFieldType}, such as instances of {Wx::RTC::RichTextFieldTypeStandard}; this makes the use of fields an efficient method of introducing extra functionality, since most of the information required to draw a field (such as a bitmap) is kept centrally in a single field type definition.
729
+ # The FieldType property, accessed by SetFieldType/GetFieldType, is used to retrieve the field type definition. So be careful not to overwrite this property.
730
+ # {Wx::RTC::RichTextField} is derived from {Wx::RTC::RichTextParagraphLayoutBox}, which means that it can contain its own read-only content, refreshed when the application calls the UpdateField function. Whether a field is treated as a composite or a single graphic is determined by the field type definition. If using {Wx::RTC::RichTextFieldTypeStandard}, passing the display type {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_COMPOSITE} to the field type definition causes the field to behave like a composite; the other display styles display a simple graphic. When implementing a composite field, you will still need to derive from {Wx::RTC::RichTextFieldTypeStandard} or {Wx::RTC::RichTextFieldType}, if only to implement UpdateField to refresh the field content appropriately. {Wx::RTC::RichTextFieldTypeStandard} is only one possible implementation, but covers common needs especially for simple, static fields using text or a bitmap.
731
+ # Register field types on application initialisation with the static function {Wx::RTC::RichTextBuffer.add_field_type}. They will be deleted automatically on application exit.
732
+ # An application can write a field to a control with {Wx::RTC::RichTextCtrl#write_field}, taking a field type, the properties for the field, and optional attributes.
185
733
  #
186
- # Field data can be included in properties.
187
- # @see Wx::RTC::RichTextField
734
+ # Category: Rich Text
735
+ # @see Wx::RTC::RichTextFieldTypeStandard
188
736
  # @see Wx::RTC::RichTextFieldType
189
- # @see Wx::RTC::RichTextFieldTypeStandard
190
- # @param buffer [Wx::RTC::RichTextBuffer]
191
- # @param pos [Integer]
192
- # @param fieldType [String]
193
- # @param properties [Wx::RTC::RichTextProperties]
194
- # @param ctrl [Wx::RTC::RichTextCtrl]
195
- # @param flags [Integer]
196
- # @param textAttr [Wx::RTC::RichTextAttr]
197
- # @return [Wx::RTC::RichTextField]
198
- def insert_field_with_undo(buffer, pos, fieldType, properties, ctrl, flags, textAttr) end
199
-
200
- # Returns the style that is appropriate for a new paragraph at this position.
201
- #
202
- # If the previous paragraph has a paragraph style name, looks up the next-paragraph style.
203
- # @param buffer [Wx::RTC::RichTextBuffer]
204
- # @param pos [Integer]
205
- # @param caretPosition [Boolean]
206
- # @param lookUpNewParaStyle [Boolean]
207
- # @return [Wx::RTC::RichTextAttr]
208
- def get_style_for_new_paragraph(buffer, pos, caretPosition=false, lookUpNewParaStyle=false) end
209
- alias_method :style_for_new_paragraph, :get_style_for_new_paragraph
210
-
211
- # Inserts an object.
212
- # @param buffer [Wx::RTC::RichTextBuffer]
213
- # @param pos [Integer]
214
- # @param object [Wx::RTC::RichTextObject]
215
- # @param ctrl [Wx::RTC::RichTextCtrl]
216
- # @param flags [Integer]
217
- # @return [Wx::RTC::RichTextObject]
218
- def insert_object_with_undo(buffer, pos, object, ctrl, flags=0) end
219
-
220
- # Submits a command to delete this range.
221
- # @param range [Range]
222
- # @param ctrl [Wx::RTC::RichTextCtrl]
223
- # @param buffer [Wx::RTC::RichTextBuffer]
224
- # @return [Boolean]
225
- def delete_range_with_undo(range, ctrl, buffer) end
226
-
227
- # Draws the floating objects in this buffer.
228
- # @param dc [Wx::DC]
229
- # @param context [Wx::RTC::RichTextDrawingContext]
230
- # @param range [Range]
231
- # @param selection [Wx::RTC::RichTextSelection]
232
- # @param rect [Wx::Rect]
233
- # @param descent [Integer]
234
- # @param style [Integer]
235
- # @return [void]
236
- def draw_floats(dc, context, range, selection, rect, descent, style) end
237
-
238
- # Moves an anchored object to another paragraph.
239
- # @param from [Wx::RTC::RichTextParagraph]
240
- # @param to [Wx::RTC::RichTextParagraph]
241
- # @param obj [Wx::RTC::RichTextObject]
242
- # @return [void]
243
- def move_anchored_object_to_paragraph(from, to, obj) end
244
-
245
- # Initializes the object.
246
- # @return [void]
247
- def init; end
248
-
249
- # Clears all the children.
250
- # @return [void]
251
- def clear; end
252
-
253
- # Clears and initializes with one blank paragraph.
254
- # @return [void]
255
- def reset; end
256
-
257
- # Convenience function to add a paragraph of text.
258
- # @param text [String]
259
- # @param paraStyle [Wx::RTC::RichTextAttr]
260
- # @return [Range]
261
- def add_paragraph(text, paraStyle=nil) end
262
-
263
- # Convenience function to add an image.
264
- # @param image [Wx::Image]
265
- # @param paraStyle [Wx::RTC::RichTextAttr]
266
- # @return [Range]
267
- def add_image(image, paraStyle=nil) end
268
-
269
- # Adds multiple paragraphs, based on newlines.
270
- # @param text [String]
271
- # @param paraStyle [Wx::RTC::RichTextAttr]
272
- # @return [Range]
273
- def add_paragraphs(text, paraStyle=nil) end
274
-
275
- # Returns the line at the given position.
276
- #
277
- # If caretPosition is true, the position is a caret position, which is normally a smaller number.
278
- # @param pos [Integer]
279
- # @param caretPosition [Boolean]
280
- # @return [Wx::RTC::RichTextLine]
281
- def get_line_at_position(pos, caretPosition=false) end
282
- alias_method :line_at_position, :get_line_at_position
283
-
284
- # Returns the line at the given y pixel position, or the last line.
285
- # @param y [Integer]
286
- # @return [Wx::RTC::RichTextLine]
287
- def get_line_at_y_position(y) end
288
- alias_method :line_at_y_position, :get_line_at_y_position
289
-
290
- # Returns the paragraph at the given character or caret position.
291
- # @param pos [Integer]
292
- # @param caretPosition [Boolean]
293
- # @return [Wx::RTC::RichTextParagraph]
294
- def get_paragraph_at_position(pos, caretPosition=false) end
295
- alias_method :paragraph_at_position, :get_paragraph_at_position
296
-
297
- # Returns the line size at the given position.
298
- # @param pos [Integer]
299
- # @param caretPosition [Boolean]
300
- # @return [Wx::Size]
301
- def get_line_size_at_position(pos, caretPosition=false) end
302
- alias_method :line_size_at_position, :get_line_size_at_position
303
-
304
- # Given a position, returns the number of the visible line (potentially many to a paragraph), starting from zero at the start of the buffer.
305
- #
306
- # We also have to pass a bool (startOfLine) that indicates whether the caret is being shown at the end of the previous line or at the start of the next, since the caret can be shown at two visible positions for the same underlying position.
307
- # @param pos [Integer]
308
- # @param caretPosition [Boolean]
309
- # @param startOfLine [Boolean]
310
- # @return [Integer]
311
- def get_visible_line_number(pos, caretPosition=false, startOfLine=false) end
312
- alias_method :visible_line_number, :get_visible_line_number
313
-
314
- # Given a line number, returns the corresponding {Wx::RTC::RichTextLine} object.
315
- # @param lineNumber [Integer]
316
- # @return [Wx::RTC::RichTextLine]
317
- def get_line_for_visible_line_number(lineNumber) end
318
- alias_method :line_for_visible_line_number, :get_line_for_visible_line_number
319
-
320
- # Returns the leaf object in a paragraph at this position.
321
- # @param position [Integer]
322
- # @return [Wx::RTC::RichTextObject]
323
- def get_leaf_object_at_position(position) end
324
- alias_method :leaf_object_at_position, :get_leaf_object_at_position
325
-
326
- # Returns the paragraph by number.
327
- # @param paragraphNumber [Integer]
328
- # @return [Wx::RTC::RichTextParagraph]
329
- def get_paragraph_at_line(paragraphNumber) end
330
- alias_method :paragraph_at_line, :get_paragraph_at_line
331
-
332
- # Returns the paragraph for a given line.
333
- # @param line [Wx::RTC::RichTextLine]
334
- # @return [Wx::RTC::RichTextParagraph]
335
- def get_paragraph_for_line(line) end
336
- alias_method :paragraph_for_line, :get_paragraph_for_line
337
-
338
- # Returns the length of the paragraph.
339
- # @param paragraphNumber [Integer]
340
- # @return [Integer]
341
- def get_paragraph_length(paragraphNumber) end
342
- alias_method :paragraph_length, :get_paragraph_length
343
-
344
- # Returns the number of paragraphs.
345
- # @return [Integer]
346
- def get_paragraph_count; end
347
- alias_method :paragraph_count, :get_paragraph_count
348
-
349
- # Returns the number of visible lines.
350
- # @return [Integer]
351
- def get_line_count; end
352
- alias_method :line_count, :get_line_count
353
-
354
- # Returns the text of the paragraph.
355
- # @param paragraphNumber [Integer]
356
- # @return [String]
357
- def get_paragraph_text(paragraphNumber) end
358
- alias_method :paragraph_text, :get_paragraph_text
359
-
360
- # Converts zero-based line column and paragraph number to a position.
361
- # @param x [Integer]
362
- # @param y [Integer]
363
- # @return [Integer]
364
- def xy_to_position(x, y) end
365
-
366
- # Converts a zero-based position to line column and paragraph number.
367
- # @param pos [Integer]
368
- # @return [Array(Boolean,Integer,Integer)]
369
- def position_to_xy(pos) end
370
-
371
- # @overload set_style(range, style, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO)
372
- # Sets the attributes for the given range.
373
- #
374
- # Pass flags to determine how the attributes are set.
375
- # The end point of range is specified as the last character position of the span of text. So, for example, to set the style for a character at position 5, use the range (5,5). This differs from the {Wx::RTC::RichTextCtrl} API, where you would specify (5,6).
376
- # flags may contain a bit list of the following values:
377
- #
378
- # - {Wx::RTC::RICHTEXT_SETSTYLE_NONE}: no style flag.
379
- # - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this operation should be undoable.
380
- # - {Wx::RTC::RICHTEXT_SETSTYLE_OPTIMIZE}: specifies that the style should not be applied if the combined style at this point is already the style in question.
381
- # - {Wx::RTC::RICHTEXT_SETSTYLE_PARAGRAPHS_ONLY}: specifies that the style should only be applied to paragraphs, and not the content. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
382
- # - {Wx::RTC::RICHTEXT_SETSTYLE_CHARACTERS_ONLY}: specifies that the style should only be applied to characters, and not the paragraph. This allows content styling to be preserved independently from that of e.g. a named paragraph style.
383
- # - {Wx::RTC::RICHTEXT_SETSTYLE_RESET}: resets (clears) the existing style before applying the new style.
384
- # - {Wx::RTC::RICHTEXT_SETSTYLE_REMOVE}: removes the specified style. Only the style flags are used in this operation.
385
- # @param range [Range]
386
- # @param style [Wx::RTC::RichTextAttr]
387
- # @param flags [Integer]
388
- # @return [Boolean]
389
- # @overload set_style(obj, textAttr, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO)
390
- # Sets the attributes for the given object only, for example the box attributes for a text box.
391
- # @param obj [Wx::RTC::RichTextObject]
392
- # @param textAttr [Wx::RTC::RichTextAttr]
393
- # @param flags [Integer]
394
- # @return [void]
395
- def set_style(*args) end
396
-
397
- # Returns the combined text attributes for this position.
398
- #
399
- # This function gets the uncombined style - that is, the attributes associated with the paragraph or character content, and not necessarily the combined attributes you see on the screen. To get the combined attributes, use {Wx::RTC::RichTextParagraphLayoutBox#get_style}. If you specify (any) paragraph attribute in style's flags, this function will fetch the paragraph attributes. Otherwise, it will return the character attributes.
400
- # @param position [Integer]
401
- # @param style [Wx::RTC::RichTextAttr]
402
- # @return [Boolean]
403
- def get_style(position, style) end
404
- alias_method :style, :get_style
405
-
406
- # Returns the content (uncombined) attributes for this position.
407
- # @param position [Integer]
408
- # @param style [Wx::RTC::RichTextAttr]
409
- # @return [Boolean]
410
- def get_uncombined_style(position, style) end
411
- alias_method :uncombined_style, :get_uncombined_style
412
-
413
- # Implementation helper for GetStyle.
414
- #
415
- # If combineStyles is true, combine base, paragraph and context attributes.
416
- # @param position [Integer]
417
- # @param style [Wx::RTC::RichTextAttr]
418
- # @param combineStyles [Boolean]
419
- # @return [Boolean]
420
- def do_get_style(position, style, combineStyles=true) end
421
-
422
- # This function gets a style representing the common, combined attributes in the given range.
423
- #
424
- # Attributes which have different values within the specified range will not be included the style flags.
425
- # The function is used to get the attributes to display in the formatting dialog: the user can edit the attributes common to the selection, and optionally specify the values of further attributes to be applied uniformly.
426
- # To apply the edited attributes, you can use {Wx::RTC::RichTextParagraphLayoutBox#set_style} specifying the {Wx::RTC::RICHTEXT_SETSTYLE_OPTIMIZE} flag, which will only apply attributes that are different from the combined attributes within the range. So, the user edits the effective, displayed attributes for the range, but his choice won't be applied unnecessarily to content. As an example, say the style for a paragraph specifies bold, but the paragraph text doesn't specify a weight. The combined style is bold, and this is what the user will see on-screen and in the formatting dialog. The user now specifies red text, in addition to bold. When applying with {Wx::RTC::RichTextParagraphLayoutBox#set_style}, the content font weight attributes won't be changed to bold because this is already specified by the paragraph. However the text colour attributes will be changed to show red.
427
- # @param range [Range]
428
- # @param style [Wx::RTC::RichTextAttr]
429
- # @return [Boolean]
430
- def get_style_for_range(range, style) end
431
- alias_method :style_for_range, :get_style_for_range
432
-
433
- # Combines style with currentStyle for the purpose of summarising the attributes of a range of content.
434
- # @param currentStyle [Wx::RTC::RichTextAttr]
435
- # @param style [Wx::RTC::RichTextAttr]
436
- # @param clashingAttr [Wx::RTC::RichTextAttr]
437
- # @param absentAttr [Wx::RTC::RichTextAttr]
438
- # @return [Boolean]
439
- def collect_style(currentStyle, style, clashingAttr, absentAttr) end
440
-
441
- # @overload set_list_style(range, def_, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1)
442
- # Sets the list attributes for the given range, passing flags to determine how the attributes are set.
443
- #
444
- # Either the style definition or the name of the style definition (in the current sheet) can be passed.
445
- # flags is a bit list of the following:
446
- #
447
- # - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this command will be undoable.
448
- # - {Wx::RTC::RICHTEXT_SETSTYLE_RENUMBER}: specifies that numbering should start from startFrom, otherwise existing attributes are used.
449
- # - {Wx::RTC::RICHTEXT_SETSTYLE_SPECIFY_LEVEL}: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.
450
- # @see Wx::RTC::RichTextParagraphLayoutBox#number_list
451
- # @see Wx::RTC::RichTextParagraphLayoutBox#promote_list
452
- # @see Wx::RTC::RichTextParagraphLayoutBox#clear_list_style.
453
- # @param range [Range]
454
- # @param def_ [Wx::RTC::RichTextListStyleDefinition]
455
- # @param flags [Integer]
456
- # @param startFrom [Integer]
457
- # @param specifiedLevel [Integer]
458
- # @return [Boolean]
459
- # @overload set_list_style(range, defName, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1)
460
- # @param range [Range]
461
- # @param defName [String]
462
- # @param flags [Integer]
463
- # @param startFrom [Integer]
464
- # @param specifiedLevel [Integer]
465
- # @return [Boolean]
466
- def set_list_style(*args) end
467
-
468
- # Clears the list style from the given range, clearing list-related attributes and applying any named paragraph style associated with each paragraph.
469
- #
470
- # flags is a bit list of the following:
471
- #
472
- # - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this command will be undoable.
473
- # @see Wx::RTC::RichTextParagraphLayoutBox#set_list_style
474
- # @see Wx::RTC::RichTextParagraphLayoutBox#promote_list
475
- # @see Wx::RTC::RichTextParagraphLayoutBox#number_list
476
- # @param range [Range]
477
- # @param flags [Integer]
478
- # @return [Boolean]
479
- def clear_list_style(range, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO) end
480
-
481
- # @overload number_list(range, def_=nil, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1)
482
- # Numbers the paragraphs in the given range.
483
- #
484
- # Pass flags to determine how the attributes are set. Either the style definition or the name of the style definition (in the current sheet) can be passed.
485
- # flags is a bit list of the following:
486
- #
487
- # - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this command will be undoable.
488
- # - {Wx::RTC::RICHTEXT_SETSTYLE_RENUMBER}: specifies that numbering should start from startFrom, otherwise existing attributes are used.
489
- # - {Wx::RTC::RICHTEXT_SETSTYLE_SPECIFY_LEVEL}: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.
490
- #
491
- # def can be NULL to indicate that the existing list style should be used.
492
- # @see Wx::RTC::RichTextParagraphLayoutBox#set_list_style
493
- # @see Wx::RTC::RichTextParagraphLayoutBox#promote_list
494
- # @see Wx::RTC::RichTextParagraphLayoutBox#clear_list_style
495
- # @param range [Range]
496
- # @param def_ [Wx::RTC::RichTextListStyleDefinition]
497
- # @param flags [Integer]
498
- # @param startFrom [Integer]
499
- # @param specifiedLevel [Integer]
500
- # @return [Boolean]
501
- # @overload number_list(range, defName, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1)
502
- # @param range [Range]
503
- # @param defName [String]
504
- # @param flags [Integer]
505
- # @param startFrom [Integer]
506
- # @param specifiedLevel [Integer]
507
- # @return [Boolean]
508
- def number_list(*args) end
509
-
510
- # @overload promote_list(promoteBy, range, def_=nil, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, specifiedLevel=-1)
511
- # Promotes the list items within the given range.
512
- #
513
- # A positive promoteBy produces a smaller indent, and a negative number produces a larger indent. Pass flags to determine how the attributes are set. Either the style definition or the name of the style definition (in the current sheet) can be passed.
514
- # flags is a bit list of the following:
515
- #
516
- # - {Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO}: specifies that this command will be undoable.
517
- # - {Wx::RTC::RICHTEXT_SETSTYLE_RENUMBER}: specifies that numbering should start from startFrom, otherwise existing attributes are used.
518
- # - {Wx::RTC::RICHTEXT_SETSTYLE_SPECIFY_LEVEL}: specifies that listLevel should be used as the level for all paragraphs, otherwise the current indentation will be used.
519
- # @see Wx::RTC::RichTextParagraphLayoutBox#set_list_style
520
- # @see Wx::RTC::RichTextParagraphLayoutBox#set_list_style
521
- # @see Wx::RTC::RichTextParagraphLayoutBox#clear_list_style
522
- # @param promoteBy [Integer]
523
- # @param range [Range]
524
- # @param def_ [Wx::RTC::RichTextListStyleDefinition]
525
- # @param flags [Integer]
526
- # @param specifiedLevel [Integer]
527
- # @return [Boolean]
528
- # @overload promote_list(promoteBy, range, defName, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, specifiedLevel=-1)
529
- # @param promoteBy [Integer]
530
- # @param range [Range]
531
- # @param defName [String]
532
- # @param flags [Integer]
533
- # @param specifiedLevel [Integer]
534
- # @return [Boolean]
535
- def promote_list(*args) end
536
-
537
- # Helper for NumberList and PromoteList, that does renumbering and promotion simultaneously def can be NULL/empty to indicate that the existing list style should be used.
538
- # @param range [Range]
539
- # @param promotionRange [Range]
540
- # @param promoteBy [Integer]
541
- # @param def_ [Wx::RTC::RichTextListStyleDefinition]
542
- # @param flags [Integer]
543
- # @param startFrom [Integer]
544
- # @param specifiedLevel [Integer]
545
- # @return [Boolean]
546
- def do_number_list(range, promotionRange, promoteBy, def_, flags=Wx::RTC::RICHTEXT_SETSTYLE_WITH_UNDO, startFrom=1, specifiedLevel=-1) end
547
-
548
- # Fills in the attributes for numbering a paragraph after previousParagraph.
549
- # @param previousParagraph [Wx::RTC::RichTextParagraph]
550
- # @param attr [Wx::RTC::RichTextAttr]
551
- # @return [Boolean]
552
- def find_next_paragraph_number(previousParagraph, attr) end
553
-
554
- # Sets the properties for the given range, passing flags to determine how the attributes are set.
555
- #
556
- # You can merge properties or replace them.
557
- # The end point of range is specified as the last character position of the span of text, plus one. So, for example, to set the properties for a character at position 5, use the range (5,6).
558
- # flags may contain a bit list of the following values:
559
- #
560
- # - {Wx::RTC::RICHTEXT_SETPROPERTIES_NONE}: no flag.
561
- # - {Wx::RTC::RICHTEXT_SETPROPERTIES_WITH_UNDO}: specifies that this operation should be undoable.
562
- # - {Wx::RTC::RICHTEXT_SETPROPERTIES_PARAGRAPHS_ONLY}: specifies that the properties should only be applied to paragraphs, and not the content.
563
- # - {Wx::RTC::RICHTEXT_SETPROPERTIES_CHARACTERS_ONLY}: specifies that the properties should only be applied to characters, and not the paragraph.
564
- # - {Wx::RTC::RICHTEXT_SETPROPERTIES_RESET}: resets (clears) the existing properties before applying the new properties.
565
- # - {Wx::RTC::RICHTEXT_SETPROPERTIES_REMOVE}: removes the specified properties.
566
- # @param range [Range]
567
- # @param properties [Wx::RTC::RichTextProperties]
568
- # @param flags [Integer]
569
- # @return [Boolean]
570
- def set_properties(range, properties, flags=Wx::RTC::RICHTEXT_SETPROPERTIES_WITH_UNDO) end
571
-
572
- # Sets with undo the properties for the given object.
573
- # @param obj [Wx::RTC::RichTextObject]
574
- # @param properties [Wx::RTC::RichTextProperties]
575
- # @param objToSet [Wx::RTC::RichTextObject]
576
- # @return [Boolean]
577
- def set_object_properties_with_undo(obj, properties, objToSet=nil) end
578
-
579
- # Test if this whole range has character attributes of the specified kind.
580
- #
581
- # If any of the attributes are different within the range, the test fails. You can use this to implement, for example, bold button updating. style must have flags indicating which attributes are of interest.
582
- # @param range [Range]
583
- # @param style [Wx::RTC::RichTextAttr]
584
- # @return [Boolean]
585
- def has_character_attributes(range, style) end
586
- alias_method :has_character_attributes?, :has_character_attributes
587
-
588
- # Test if this whole range has paragraph attributes of the specified kind.
589
- #
590
- # If any of the attributes are different within the range, the test fails. You can use this to implement, for example, centering button updating. style must have flags indicating which attributes are of interest.
591
- # @param range [Range]
592
- # @param style [Wx::RTC::RichTextAttr]
593
- # @return [Boolean]
594
- def has_paragraph_attributes(range, style) end
595
- alias_method :has_paragraph_attributes?, :has_paragraph_attributes
596
-
597
- # Clones the object.
598
- # @return [Wx::RTC::RichTextObject]
599
- def clone; end
600
-
601
- # Prepares the content just before insertion (or after buffer reset).
602
- #
603
- # Currently is only called if undo mode is on.
604
- # @param container [Wx::RTC::RichTextParagraphLayoutBox]
605
- # @return [void]
606
- def prepare_content(container) end
607
-
608
- # Insert fragment into this box at the given position.
609
- #
610
- # If partialParagraph is true, it is assumed that the last (or only) paragraph is just a piece of data with no paragraph marker.
611
- # @param position [Integer]
612
- # @param fragment [Wx::RTC::RichTextParagraphLayoutBox]
613
- # @return [Boolean]
614
- def insert_fragment(position, fragment) end
615
-
616
- # Make a copy of the fragment corresponding to the given range, putting it in fragment.
617
- # @param range [Range]
618
- # @param fragment [Wx::RTC::RichTextParagraphLayoutBox]
619
- # @return [Boolean]
620
- def copy_fragment(range, fragment) end
621
-
622
- # Apply the style sheet to the buffer, for example if the styles have changed.
623
- # @param styleSheet [Wx::RTC::RichTextStyleSheet]
624
- # @return [Boolean]
625
- def apply_style_sheet(styleSheet) end
626
-
627
- # @param obj [Wx::RTC::RichTextParagraphLayoutBox]
628
- # @return [void]
629
- def copy(obj) end
630
-
631
- # Calculate ranges.
632
- # @return [void]
633
- def update_ranges; end
634
-
635
- # Get all the text.
636
- # @return [String]
637
- def get_text; end
638
- alias_method :text, :get_text
639
-
640
- # Sets the default style, affecting the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold).
737
+ # @see Wx::RTC::RichTextParagraphLayoutBox
738
+ # @see Wx::RTC::RichTextProperties
739
+ # @see Wx::RTC::RichTextCtrl
641
740
  #
642
- # This is not cumulative - setting the default style will replace the previous default style.
643
- # Setting it to a default attribute object makes new content take on the 'basic' style.
644
- # @param style [Wx::RTC::RichTextAttr]
645
- # @return [Boolean]
646
- def set_default_style(style) end
647
- alias_method :default_style=, :set_default_style
648
-
649
- # Returns the current default style, affecting the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold).
650
- # @return [Wx::RTC::RichTextAttr]
651
- def get_default_style; end
652
- alias_method :default_style, :get_default_style
653
-
654
- # Sets the basic (overall) style.
655
741
  #
656
- # This is the style of the whole buffer before further styles are applied, unlike the default style, which only affects the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold).
657
- # @param style [Wx::RTC::RichTextAttr]
658
- # @return [void]
659
- def set_basic_style(style) end
660
- alias_method :basic_style=, :set_basic_style
661
-
662
- # Returns the basic (overall) style.
663
742
  #
664
- # This is the style of the whole buffer before further styles are applied, unlike the default style, which only affects the style currently being applied (for example, setting the default style to bold will cause subsequently inserted text to be bold).
665
- # @return [Wx::RTC::RichTextAttr]
666
- def get_basic_style; end
667
- alias_method :basic_style, :get_basic_style
668
-
669
- # Invalidates the buffer.
743
+ # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
744
+ # @wxrb_require USE_RICHTEXT
745
+ class RichTextField < RichTextParagraphLayoutBox
746
+
747
+ # @overload initialize(fieldType=(''), parent=nil)
748
+ # Default constructor; optionally pass the parent object.
749
+ # @param fieldType [String]
750
+ # @param parent [Wx::RTC::RichTextObject]
751
+ # @return [Wx::RTC::RichTextField]
752
+ # @overload initialize(obj)
753
+ # Copy constructor.
754
+ # @param obj [Wx::RTC::RichTextField]
755
+ # @return [Wx::RTC::RichTextField]
756
+ def initialize(*args) end
757
+
758
+ # Draw the item, within the given range.
759
+ #
760
+ # Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)
761
+ # @param dc [Wx::DC]
762
+ # @param context [Wx::RTC::RichTextDrawingContext]
763
+ # @param range [Range]
764
+ # @param selection [Wx::RTC::RichTextSelection]
765
+ # @param rect [Wx::Rect]
766
+ # @param descent [Integer]
767
+ # @param style [Integer]
768
+ # @return [Boolean]
769
+ def draw(dc, context, range, selection, rect, descent, style) end
770
+
771
+ # Lay the item out at the specified position with the given size constraint.
772
+ #
773
+ # 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).
774
+ # @param dc [Wx::DC]
775
+ # @param context [Wx::RTC::RichTextDrawingContext]
776
+ # @param rect [Wx::Rect]
777
+ # @param parentRect [Wx::Rect]
778
+ # @param style [Integer]
779
+ # @return [Boolean]
780
+ def layout(dc, context, rect, parentRect, style) end
781
+
782
+ # Returns the object size for the given range.
783
+ #
784
+ # Returns false if the range is invalid for this object.
785
+ # @param range [Range]
786
+ # @param size [Array(Integer, Integer), Wx::Size]
787
+ # @param descent [int]
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 [Boolean]
795
+ def get_range_size(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 the XML node name of this object.
799
+ #
800
+ # This must be overridden for {Wx::XmlNode}-base XML export to work.
801
+ # @return [String]
802
+ def get_xml_node_name; end
803
+ alias_method :xml_node_name, :get_xml_node_name
804
+
805
+ # Returns true if we can edit the object's properties via a GUI.
806
+ # @return [Boolean]
807
+ def can_edit_properties; end
808
+ alias_method :can_edit_properties?, :can_edit_properties
809
+
810
+ # Edits the object's properties via a GUI.
811
+ # @param parent [Wx::Window]
812
+ # @param buffer [Wx::RTC::RichTextBuffer]
813
+ # @return [Boolean]
814
+ def edit_properties(parent, buffer) end
815
+
816
+ # Returns the label to be used for the properties context menu item.
817
+ # @return [String]
818
+ def get_properties_menu_label; end
819
+ alias_method :properties_menu_label, :get_properties_menu_label
820
+
821
+ # Returns true if objects of this class can accept the focus, i.e. a call to SetFocusObject is possible.
822
+ #
823
+ # For example, containers supporting text, such as a text box object, can accept the focus, but a table can't (set the focus to individual cells instead).
824
+ # @return [Boolean]
825
+ def accepts_focus; end
826
+
827
+ # Calculates the range of the object.
828
+ #
829
+ # By default, guess that the object is 1 unit long.
830
+ # @param start [Integer]
831
+ # @param end_ [Integer]
832
+ # @return [Integer]
833
+ def calculate_range(start, end_) end
834
+
835
+ # If a field has children, we don't want the user to be able to edit it.
836
+ # @return [Boolean]
837
+ def is_atomic; end
838
+ alias_method :atomic?, :is_atomic
839
+
840
+ # Returns true if the buffer is empty.
841
+ # @return [Boolean]
842
+ def is_empty; end
843
+ alias_method :empty?, :is_empty
844
+
845
+ # Returns true if this object is top-level, i.e. contains its own paragraphs, such as a text box.
846
+ # @return [Boolean]
847
+ def is_top_level; end
848
+ alias_method :top_level?, :is_top_level
849
+
850
+ # @param fieldType [String]
851
+ # @return [void]
852
+ def set_field_type(fieldType) end
853
+ alias_method :field_type=, :set_field_type
854
+
855
+ # @return [String]
856
+ def get_field_type; end
857
+ alias_method :field_type, :get_field_type
858
+
859
+ # Update the field; delegated to the associated field type.
860
+ #
861
+ # This would typically expand the field to its value, if this is a dynamically changing and/or composite field.
862
+ # @param buffer [Wx::RTC::RichTextBuffer]
863
+ # @return [Boolean]
864
+ def update_field(buffer) end
865
+
866
+ # Clones the object.
867
+ # @return [Wx::RTC::RichTextObject]
868
+ def clone; end
869
+
870
+ # @param obj [Wx::RTC::RichTextField]
871
+ # @return [void]
872
+ def copy(obj) end
873
+
874
+ end # RichTextField
875
+
876
+ # A style sheet contains named paragraph and character styles that make it easy for a user to apply combinations of attributes to a {Wx::RTC::RichTextCtrl}.
670
877
  #
671
- # With no argument, invalidates whole buffer.
672
- # @param invalidRange [Range]
673
- # @return [void]
674
- def invalidate(invalidRange=Wx::RICHTEXT_ALL) end
675
-
676
- # Do the (in)validation for this object only.
677
- # @param invalidRange [Range]
678
- # @return [void]
679
- def do_invalidate(invalidRange) end
680
-
681
- # Do the (in)validation both up and down the hierarchy.
682
- # @param invalidRange [Range]
683
- # @return [void]
684
- def invalidate_hierarchy(invalidRange=Wx::RICHTEXT_ALL) end
685
-
686
- # Gather information about floating objects.
878
+ # You can use a {Wx::RTC::RichTextStyleListBox} in your user interface to show available styles to the user, and allow application of styles to the control.
687
879
  #
688
- # If untilObj is non-NULL, will stop getting information if the current object is this, since we will collect the rest later.
689
- # @param availableRect [Wx::Rect]
690
- # @param untilObj [Wx::RTC::RichTextObject]
691
- # @return [Boolean]
692
- def update_floating_objects(availableRect, untilObj=nil) end
693
-
694
- # Get invalid range, rounding to entire paragraphs if argument is true.
695
- # @param wholeParagraphs [Boolean]
696
- # @return [Range]
697
- def get_invalid_range(wholeParagraphs=false) end
698
- alias_method :invalid_range, :get_invalid_range
699
-
700
- # Returns true if this object needs layout.
701
- # @return [Boolean]
702
- def is_dirty; end
703
- alias_method :dirty?, :is_dirty
704
-
705
- # Returns the {Wx::RTC::RichTextFloatCollector} of this object.
706
- # @return [Wx::RTC::RichTextFloatCollector]
707
- def get_float_collector; end
708
- alias_method :float_collector, :get_float_collector
709
-
710
- # Returns the number of floating objects at this level.
711
- # @return [Integer]
712
- def get_floating_object_count; end
713
- alias_method :floating_object_count, :get_floating_object_count
714
-
715
- # Returns a list of floating objects.
716
- # @param objects [Array<Wx::RTC::RichTextObject>]
717
- # @return [Boolean]
718
- def get_floating_objects(objects) end
719
- alias_method :floating_objects, :get_floating_objects
720
-
721
- end # RichTextParagraphLayoutBox
722
-
723
- # This class implements the general concept of a field, an object that represents additional functionality such as a footnote, a bookmark, a page number, a table of contents, and so on.
724
- #
725
- # Extra information (such as a bookmark name) can be stored in the object properties.
726
- # Drawing, layout, and property editing is delegated to classes derived from {Wx::RTC::RichTextFieldType}, such as instances of {Wx::RTC::RichTextFieldTypeStandard}; this makes the use of fields an efficient method of introducing extra functionality, since most of the information required to draw a field (such as a bitmap) is kept centrally in a single field type definition.
727
- # The FieldType property, accessed by SetFieldType/GetFieldType, is used to retrieve the field type definition. So be careful not to overwrite this property.
728
- # {Wx::RTC::RichTextField} is derived from {Wx::RTC::RichTextParagraphLayoutBox}, which means that it can contain its own read-only content, refreshed when the application calls the UpdateField function. Whether a field is treated as a composite or a single graphic is determined by the field type definition. If using {Wx::RTC::RichTextFieldTypeStandard}, passing the display type {Wx::RTC::RichTextFieldTypeStandard::RICHTEXT_FIELD_STYLE_COMPOSITE} to the field type definition causes the field to behave like a composite; the other display styles display a simple graphic. When implementing a composite field, you will still need to derive from {Wx::RTC::RichTextFieldTypeStandard} or {Wx::RTC::RichTextFieldType}, if only to implement UpdateField to refresh the field content appropriately. {Wx::RTC::RichTextFieldTypeStandard} is only one possible implementation, but covers common needs especially for simple, static fields using text or a bitmap.
729
- # Register field types on application initialisation with the static function {Wx::RTC::RichTextBuffer.add_field_type}. They will be deleted automatically on application exit.
730
- # An application can write a field to a control with {Wx::RTC::RichTextCtrl#write_field}, taking a field type, the properties for the field, and optional attributes.
731
- #
732
- # Category: Rich Text
733
- # @see Wx::RTC::RichTextFieldTypeStandard
734
- # @see Wx::RTC::RichTextFieldType
735
- # @see Wx::RTC::RichTextParagraphLayoutBox
736
- # @see Wx::RTC::RichTextProperties
737
- # @see Wx::RTC::RichTextCtrl
738
- #
739
- #
740
- #
741
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
742
- # @wxrb_require USE_RICHTEXT
743
- class RichTextField < RichTextParagraphLayoutBox
744
-
745
- # @overload initialize(fieldType=(''), parent=nil)
746
- # Default constructor; optionally pass the parent object.
747
- # @param fieldType [String]
748
- # @param parent [Wx::RTC::RichTextObject]
749
- # @return [Wx::RTC::RichTextField]
750
- # @overload initialize(obj)
751
- # Copy constructor.
752
- # @param obj [Wx::RTC::RichTextField]
753
- # @return [Wx::RTC::RichTextField]
754
- def initialize(*args) end
755
-
756
- # Draw the item, within the given range.
880
+ # Category: Rich Text
757
881
  #
758
- # Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)
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(dc, context, range, selection, rect, descent, style) end
768
-
769
- # Lay the item out at the specified position with the given size constraint.
882
+ # @wxrb_require USE_RICHTEXT
883
+ class RichTextStyleSheet < Object
884
+
885
+ # Constructor.
886
+ # @return [Wx::RTC::RichTextStyleSheet]
887
+ def initialize; end
888
+
889
+ # Adds a definition to the character style list.
890
+ # @param def_ [Wx::RTC::RichTextCharacterStyleDefinition]
891
+ # @return [Boolean]
892
+ def add_character_style(def_) end
893
+
894
+ # Adds a definition to the list style list.
895
+ # @param def_ [Wx::RTC::RichTextListStyleDefinition]
896
+ # @return [Boolean]
897
+ def add_list_style(def_) end
898
+
899
+ # Adds a definition to the paragraph style list.
900
+ # @param def_ [Wx::RTC::RichTextParagraphStyleDefinition]
901
+ # @return [Boolean]
902
+ def add_paragraph_style(def_) end
903
+
904
+ # Adds a definition to the appropriate style list.
905
+ # @param def_ [Wx::RTC::RichTextStyleDefinition]
906
+ # @return [Boolean]
907
+ def add_style(def_) end
908
+
909
+ # Deletes all styles.
910
+ # @return [void]
911
+ def delete_styles; end
912
+
913
+ # Finds a character definition by name.
914
+ # @param name [String]
915
+ # @param recurse [Boolean]
916
+ # @return [Wx::RTC::RichTextCharacterStyleDefinition]
917
+ def find_character_style(name, recurse=true) end
918
+
919
+ # Finds a list definition by name.
920
+ # @param name [String]
921
+ # @param recurse [Boolean]
922
+ # @return [Wx::RTC::RichTextListStyleDefinition]
923
+ def find_list_style(name, recurse=true) end
924
+
925
+ # Finds a paragraph definition by name.
926
+ # @param name [String]
927
+ # @param recurse [Boolean]
928
+ # @return [Wx::RTC::RichTextParagraphStyleDefinition]
929
+ def find_paragraph_style(name, recurse=true) end
930
+
931
+ # Finds a style definition by name.
932
+ # @param name [String]
933
+ # @return [Wx::RTC::RichTextStyleDefinition]
934
+ def find_style(name) end
935
+
936
+ # Returns the nth character style.
937
+ # @param n [Integer]
938
+ # @return [Wx::RTC::RichTextCharacterStyleDefinition]
939
+ def get_character_style(n) end
940
+ alias_method :character_style, :get_character_style
941
+
942
+ # Returns the number of character styles.
943
+ # @return [Integer]
944
+ def get_character_style_count; end
945
+ alias_method :character_style_count, :get_character_style_count
946
+
947
+ # Returns the style sheet's description.
948
+ # @return [Wx::String]
949
+ def get_description; end
950
+ alias_method :description, :get_description
951
+
952
+ # Returns the nth list style.
953
+ # @param n [Integer]
954
+ # @return [Wx::RTC::RichTextListStyleDefinition]
955
+ def get_list_style(n) end
956
+ alias_method :list_style, :get_list_style
957
+
958
+ # Returns the number of list styles.
959
+ # @return [Integer]
960
+ def get_list_style_count; end
961
+ alias_method :list_style_count, :get_list_style_count
962
+
963
+ # Returns the style sheet's name.
964
+ # @return [Wx::String]
965
+ def get_name; end
966
+ alias_method :name, :get_name
967
+
968
+ # Returns the nth paragraph style.
969
+ # @param n [Integer]
970
+ # @return [Wx::RTC::RichTextParagraphStyleDefinition]
971
+ def get_paragraph_style(n) end
972
+ alias_method :paragraph_style, :get_paragraph_style
973
+
974
+ # Returns the number of paragraph styles.
975
+ # @return [Integer]
976
+ def get_paragraph_style_count; end
977
+ alias_method :paragraph_style_count, :get_paragraph_style_count
978
+
979
+ # Removes a character style.
980
+ # @param def_ [Wx::RTC::RichTextStyleDefinition]
981
+ # @param deleteStyle [Boolean]
982
+ # @return [Boolean]
983
+ def remove_character_style(def_, deleteStyle=false) end
984
+
985
+ # Removes a list style.
986
+ # @param def_ [Wx::RTC::RichTextStyleDefinition]
987
+ # @param deleteStyle [Boolean]
988
+ # @return [Boolean]
989
+ def remove_list_style(def_, deleteStyle=false) end
990
+
991
+ # Removes a paragraph style.
992
+ # @param def_ [Wx::RTC::RichTextStyleDefinition]
993
+ # @param deleteStyle [Boolean]
994
+ # @return [Boolean]
995
+ def remove_paragraph_style(def_, deleteStyle=false) end
996
+
997
+ # Removes a style.
998
+ # @param def_ [Wx::RTC::RichTextStyleDefinition]
999
+ # @param deleteStyle [Boolean]
1000
+ # @return [Boolean]
1001
+ def remove_style(def_, deleteStyle=false) end
1002
+
1003
+ # Sets the style sheet's description.
1004
+ # @param descr [String]
1005
+ # @return [void]
1006
+ def set_description(descr) end
1007
+ alias_method :description=, :set_description
1008
+
1009
+ # Sets the style sheet's name.
1010
+ # @param name [String]
1011
+ # @return [void]
1012
+ def set_name(name) end
1013
+ alias_method :name=, :set_name
1014
+
1015
+ # Returns the sheet's properties.
1016
+ # @return [Wx::RTC::RichTextProperties]
1017
+ def get_properties; end
1018
+ alias_method :properties, :get_properties
1019
+
1020
+ # Sets the sheet's properties.
1021
+ # @param props [Wx::RTC::RichTextProperties]
1022
+ # @return [void]
1023
+ def set_properties(props) end
1024
+ alias_method :properties=, :set_properties
1025
+
1026
+ end # RichTextStyleSheet
1027
+
1028
+ # This is a base class for paragraph and character styles.
770
1029
  #
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 dc [Wx::DC]
773
- # @param context [Wx::RTC::RichTextDrawingContext]
774
- # @param rect [Wx::Rect]
775
- # @param parentRect [Wx::Rect]
776
- # @param style [Integer]
777
- # @return [Boolean]
778
- def layout(dc, context, rect, parentRect, style) end
779
-
780
- # Returns the object size for the given range.
1030
+ # Category: Rich Text
781
1031
  #
782
- # Returns false if the range is invalid for this object.
783
- # @param range [Range]
784
- # @param size [Array(Integer, Integer), Wx::Size]
785
- # @param descent [int]
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 [Boolean]
793
- def get_range_size(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 the XML node name of this object.
1032
+ # @wxrb_require USE_RICHTEXT
1033
+ class RichTextStyleDefinition < Object
1034
+
1035
+ # Constructor.
1036
+ # @param name [String]
1037
+ # @return [Wx::RTC::RichTextStyleDefinition]
1038
+ def initialize(name=('')) end
1039
+
1040
+ # Returns the style on which this style is based.
1041
+ # @return [Wx::String]
1042
+ def get_base_style; end
1043
+ alias_method :base_style, :get_base_style
1044
+
1045
+ # Returns the style's description.
1046
+ # @return [Wx::String]
1047
+ def get_description; end
1048
+ alias_method :description, :get_description
1049
+
1050
+ # Returns the style name.
1051
+ # @return [Wx::String]
1052
+ def get_name; end
1053
+ alias_method :name, :get_name
1054
+
1055
+ # Returns the style attributes combined with the attributes of the specified base style, if any.
1056
+ #
1057
+ # This function works recursively.
1058
+ # @param sheet [Wx::RTC::RichTextStyleSheet]
1059
+ # @return [Wx::RTC::RichTextAttr]
1060
+ def get_style_merged_with_base(sheet) end
1061
+ alias_method :style_merged_with_base, :get_style_merged_with_base
1062
+
1063
+ # Sets the name of the style that this style is based on.
1064
+ # @param name [String]
1065
+ # @return [void]
1066
+ def set_base_style(name) end
1067
+ alias_method :base_style=, :set_base_style
1068
+
1069
+ # Sets the style description.
1070
+ # @param descr [String]
1071
+ # @return [void]
1072
+ def set_description(descr) end
1073
+ alias_method :description=, :set_description
1074
+
1075
+ # Sets the name of the style.
1076
+ # @param name [String]
1077
+ # @return [void]
1078
+ def set_name(name) end
1079
+ alias_method :name=, :set_name
1080
+
1081
+ # Sets the attributes for this style.
1082
+ # @param style [Wx::RTC::RichTextAttr]
1083
+ # @return [void]
1084
+ def set_style(style) end
1085
+ alias_method :style=, :set_style
1086
+
1087
+ # Returns the definition's properties.
1088
+ # @return [Wx::RTC::RichTextProperties]
1089
+ def get_properties; end
1090
+ alias_method :properties, :get_properties
1091
+
1092
+ # Sets the definition's properties.
1093
+ # @param props [Wx::RTC::RichTextProperties]
1094
+ # @return [void]
1095
+ def set_properties(props) end
1096
+ alias_method :properties=, :set_properties
1097
+
1098
+ end # RichTextStyleDefinition
1099
+
1100
+ # This class represents a character style definition, usually added to a {Wx::RTC::RichTextStyleSheet}.
797
1101
  #
798
- # This must be overridden for {Wx::XmlNode}-base XML export to work.
799
- # @return [String]
800
- def get_xml_node_name; end
801
- alias_method :xml_node_name, :get_xml_node_name
802
-
803
- # Returns true if we can edit the object's properties via a GUI.
804
- # @return [Boolean]
805
- def can_edit_properties; end
806
- alias_method :can_edit_properties?, :can_edit_properties
807
-
808
- # Edits the object's properties via a GUI.
809
- # @param parent [Wx::Window]
810
- # @param buffer [Wx::RTC::RichTextBuffer]
811
- # @return [Boolean]
812
- def edit_properties(parent, buffer) end
813
-
814
- # Returns the label to be used for the properties context menu item.
815
- # @return [String]
816
- def get_properties_menu_label; end
817
- alias_method :properties_menu_label, :get_properties_menu_label
818
-
819
- # Returns true if objects of this class can accept the focus, i.e. a call to SetFocusObject is possible.
820
- #
821
- # For example, containers supporting text, such as a text box object, can accept the focus, but a table can't (set the focus to individual cells instead).
822
- # @return [Boolean]
823
- def accepts_focus; end
824
-
825
- # Calculates the range of the object.
1102
+ # Category: Rich Text
826
1103
  #
827
- # By default, guess that the object is 1 unit long.
828
- # @param start [Integer]
829
- # @param end_ [Integer]
830
- # @return [Integer]
831
- def calculate_range(start, end_) end
832
-
833
- # If a field has children, we don't want the user to be able to edit it.
834
- # @return [Boolean]
835
- def is_atomic; end
836
- alias_method :atomic?, :is_atomic
837
-
838
- # Returns true if the buffer is empty.
839
- # @return [Boolean]
840
- def is_empty; end
841
- alias_method :empty?, :is_empty
842
-
843
- # Returns true if this object is top-level, i.e. contains its own paragraphs, such as a text box.
844
- # @return [Boolean]
845
- def is_top_level; end
846
- alias_method :top_level?, :is_top_level
1104
+ # @wxrb_require USE_RICHTEXT
1105
+ class RichTextCharacterStyleDefinition < RichTextStyleDefinition
847
1106
 
848
- # @param fieldType [String]
849
- # @return [void]
850
- def set_field_type(fieldType) end
851
- alias_method :field_type=, :set_field_type
1107
+ # Constructor.
1108
+ # @param name [String]
1109
+ # @return [Wx::RTC::RichTextCharacterStyleDefinition]
1110
+ def initialize(name=('')) end
1111
+
1112
+ end # RichTextCharacterStyleDefinition
852
1113
 
853
- # @return [String]
854
- def get_field_type; end
855
- alias_method :field_type, :get_field_type
856
-
857
- # Update the field; delegated to the associated field type.
1114
+ # This class represents a paragraph style definition, usually added to a {Wx::RTC::RichTextStyleSheet}.
858
1115
  #
859
- # This would typically expand the field to its value, if this is a dynamically changing and/or composite field.
860
- # @param buffer [Wx::RTC::RichTextBuffer]
861
- # @return [Boolean]
862
- def update_field(buffer) end
863
-
864
- # Clones the object.
865
- # @return [Wx::RTC::RichTextObject]
866
- def clone; end
867
-
868
- # @param obj [Wx::RTC::RichTextField]
869
- # @return [void]
870
- def copy(obj) end
871
-
872
- end # RichTextField
873
-
874
- # A style sheet contains named paragraph and character styles that make it easy for a user to apply combinations of attributes to a {Wx::RTC::RichTextCtrl}.
875
- #
876
- # You can use a {Wx::RTC::RichTextStyleListBox} in your user interface to show available styles to the user, and allow application of styles to the control.
877
- #
878
- # Category: Rich Text
879
- #
880
- # @wxrb_require USE_RICHTEXT
881
- class RichTextStyleSheet < Object
882
-
883
- # Constructor.
884
- # @return [Wx::RTC::RichTextStyleSheet]
885
- def initialize; end
886
-
887
- # Adds a definition to the character style list.
888
- # @param def_ [Wx::RTC::RichTextCharacterStyleDefinition]
889
- # @return [Boolean]
890
- def add_character_style(def_) end
891
-
892
- # Adds a definition to the list style list.
893
- # @param def_ [Wx::RTC::RichTextListStyleDefinition]
894
- # @return [Boolean]
895
- def add_list_style(def_) end
896
-
897
- # Adds a definition to the paragraph style list.
898
- # @param def_ [Wx::RTC::RichTextParagraphStyleDefinition]
899
- # @return [Boolean]
900
- def add_paragraph_style(def_) end
901
-
902
- # Adds a definition to the appropriate style list.
903
- # @param def_ [Wx::RTC::RichTextStyleDefinition]
904
- # @return [Boolean]
905
- def add_style(def_) end
906
-
907
- # Deletes all styles.
908
- # @return [void]
909
- def delete_styles; end
910
-
911
- # Finds a character definition by name.
912
- # @param name [String]
913
- # @param recurse [Boolean]
914
- # @return [Wx::RTC::RichTextCharacterStyleDefinition]
915
- def find_character_style(name, recurse=true) end
916
-
917
- # Finds a list definition by name.
918
- # @param name [String]
919
- # @param recurse [Boolean]
920
- # @return [Wx::RTC::RichTextListStyleDefinition]
921
- def find_list_style(name, recurse=true) end
922
-
923
- # Finds a paragraph definition by name.
924
- # @param name [String]
925
- # @param recurse [Boolean]
926
- # @return [Wx::RTC::RichTextParagraphStyleDefinition]
927
- def find_paragraph_style(name, recurse=true) end
928
-
929
- # Finds a style definition by name.
930
- # @param name [String]
931
- # @return [Wx::RTC::RichTextStyleDefinition]
932
- def find_style(name) end
933
-
934
- # Returns the nth character style.
935
- # @param n [Integer]
936
- # @return [Wx::RTC::RichTextCharacterStyleDefinition]
937
- def get_character_style(n) end
938
- alias_method :character_style, :get_character_style
939
-
940
- # Returns the number of character styles.
941
- # @return [Integer]
942
- def get_character_style_count; end
943
- alias_method :character_style_count, :get_character_style_count
944
-
945
- # Returns the style sheet's description.
946
- # @return [Wx::String]
947
- def get_description; end
948
- alias_method :description, :get_description
949
-
950
- # Returns the nth list style.
951
- # @param n [Integer]
952
- # @return [Wx::RTC::RichTextListStyleDefinition]
953
- def get_list_style(n) end
954
- alias_method :list_style, :get_list_style
955
-
956
- # Returns the number of list styles.
957
- # @return [Integer]
958
- def get_list_style_count; end
959
- alias_method :list_style_count, :get_list_style_count
960
-
961
- # Returns the style sheet's name.
962
- # @return [Wx::String]
963
- def get_name; end
964
- alias_method :name, :get_name
965
-
966
- # Returns the nth paragraph style.
967
- # @param n [Integer]
968
- # @return [Wx::RTC::RichTextParagraphStyleDefinition]
969
- def get_paragraph_style(n) end
970
- alias_method :paragraph_style, :get_paragraph_style
971
-
972
- # Returns the number of paragraph styles.
973
- # @return [Integer]
974
- def get_paragraph_style_count; end
975
- alias_method :paragraph_style_count, :get_paragraph_style_count
976
-
977
- # Removes a character style.
978
- # @param def_ [Wx::RTC::RichTextStyleDefinition]
979
- # @param deleteStyle [Boolean]
980
- # @return [Boolean]
981
- def remove_character_style(def_, deleteStyle=false) end
982
-
983
- # Removes a list style.
984
- # @param def_ [Wx::RTC::RichTextStyleDefinition]
985
- # @param deleteStyle [Boolean]
986
- # @return [Boolean]
987
- def remove_list_style(def_, deleteStyle=false) end
988
-
989
- # Removes a paragraph style.
990
- # @param def_ [Wx::RTC::RichTextStyleDefinition]
991
- # @param deleteStyle [Boolean]
992
- # @return [Boolean]
993
- def remove_paragraph_style(def_, deleteStyle=false) end
994
-
995
- # Removes a style.
996
- # @param def_ [Wx::RTC::RichTextStyleDefinition]
997
- # @param deleteStyle [Boolean]
998
- # @return [Boolean]
999
- def remove_style(def_, deleteStyle=false) end
1000
-
1001
- # Sets the style sheet's description.
1002
- # @param descr [String]
1003
- # @return [void]
1004
- def set_description(descr) end
1005
- alias_method :description=, :set_description
1006
-
1007
- # Sets the style sheet's name.
1008
- # @param name [String]
1009
- # @return [void]
1010
- def set_name(name) end
1011
- alias_method :name=, :set_name
1012
-
1013
- # Returns the sheet's properties.
1014
- # @return [Wx::RTC::RichTextProperties]
1015
- def get_properties; end
1016
- alias_method :properties, :get_properties
1017
-
1018
- # Sets the sheet's properties.
1019
- # @param props [Wx::RTC::RichTextProperties]
1020
- # @return [void]
1021
- def set_properties(props) end
1022
- alias_method :properties=, :set_properties
1023
-
1024
- end # RichTextStyleSheet
1025
-
1026
- # This is a base class for paragraph and character styles.
1027
- #
1028
- # Category: Rich Text
1029
- #
1030
- # @wxrb_require USE_RICHTEXT
1031
- class RichTextStyleDefinition < Object
1032
-
1033
- # Constructor.
1034
- # @param name [String]
1035
- # @return [Wx::RTC::RichTextStyleDefinition]
1036
- def initialize(name=('')) end
1037
-
1038
- # Returns the style on which this style is based.
1039
- # @return [Wx::String]
1040
- def get_base_style; end
1041
- alias_method :base_style, :get_base_style
1042
-
1043
- # Returns the style's description.
1044
- # @return [Wx::String]
1045
- def get_description; end
1046
- alias_method :description, :get_description
1047
-
1048
- # Returns the style name.
1049
- # @return [Wx::String]
1050
- def get_name; end
1051
- alias_method :name, :get_name
1052
-
1053
- # Returns the style attributes combined with the attributes of the specified base style, if any.
1054
- #
1055
- # This function works recursively.
1056
- # @param sheet [Wx::RTC::RichTextStyleSheet]
1057
- # @return [Wx::RTC::RichTextAttr]
1058
- def get_style_merged_with_base(sheet) end
1059
- alias_method :style_merged_with_base, :get_style_merged_with_base
1060
-
1061
- # Sets the name of the style that this style is based on.
1062
- # @param name [String]
1063
- # @return [void]
1064
- def set_base_style(name) end
1065
- alias_method :base_style=, :set_base_style
1066
-
1067
- # Sets the style description.
1068
- # @param descr [String]
1069
- # @return [void]
1070
- def set_description(descr) end
1071
- alias_method :description=, :set_description
1072
-
1073
- # Sets the name of the style.
1074
- # @param name [String]
1075
- # @return [void]
1076
- def set_name(name) end
1077
- alias_method :name=, :set_name
1078
-
1079
- # Sets the attributes for this style.
1080
- # @param style [Wx::RTC::RichTextAttr]
1081
- # @return [void]
1082
- def set_style(style) end
1083
- alias_method :style=, :set_style
1084
-
1085
- # Returns the definition's properties.
1086
- # @return [Wx::RTC::RichTextProperties]
1087
- def get_properties; end
1088
- alias_method :properties, :get_properties
1089
-
1090
- # Sets the definition's properties.
1091
- # @param props [Wx::RTC::RichTextProperties]
1092
- # @return [void]
1093
- def set_properties(props) end
1094
- alias_method :properties=, :set_properties
1095
-
1096
- end # RichTextStyleDefinition
1097
-
1098
- # This class represents a character style definition, usually added to a {Wx::RTC::RichTextStyleSheet}.
1099
- #
1100
- # Category: Rich Text
1101
- #
1102
- # @wxrb_require USE_RICHTEXT
1103
- class RichTextCharacterStyleDefinition < RichTextStyleDefinition
1104
-
1105
- # Constructor.
1106
- # @param name [String]
1107
- # @return [Wx::RTC::RichTextCharacterStyleDefinition]
1108
- def initialize(name=('')) end
1109
-
1110
- end # RichTextCharacterStyleDefinition
1111
-
1112
- # This class represents a paragraph style definition, usually added to a {Wx::RTC::RichTextStyleSheet}.
1113
- #
1114
- # Category: Rich Text
1115
- #
1116
- # @wxrb_require USE_RICHTEXT
1117
- class RichTextParagraphStyleDefinition < RichTextStyleDefinition
1118
-
1119
- # Constructor.
1120
- # @param name [String]
1121
- # @return [Wx::RTC::RichTextParagraphStyleDefinition]
1122
- def initialize(name=('')) end
1123
-
1124
- # Returns the style that should normally follow this style.
1125
- # @return [Wx::String]
1126
- def get_next_style; end
1127
- alias_method :next_style, :get_next_style
1128
-
1129
- # Sets the style that should normally follow this style.
1130
- # @param name [String]
1131
- # @return [void]
1132
- def set_next_style(name) end
1133
- alias_method :next_style=, :set_next_style
1134
-
1135
- end # RichTextParagraphStyleDefinition
1136
-
1137
- # This class represents a list style definition, usually added to a {Wx::RTC::RichTextStyleSheet}.
1138
- #
1139
- # The class inherits paragraph attributes from {Wx::RichTextStyleParagraphDefinition}, and adds 10 further attribute objects, one for each level of a list. When applying a list style to a paragraph, the list style's base and appropriate level attributes are merged with the paragraph's existing attributes.
1140
- # You can apply a list style to one or more paragraphs using {Wx::RTC::RichTextCtrl#set_list_style}. You can also use the functions {Wx::RTC::RichTextCtrl#number_list}, {Wx::RTC::RichTextCtrl#promote_list} and {Wx::RTC::RichTextCtrl#clear_list_style}.
1141
- # As usual, there are {Wx::RTC::RichTextBuffer} versions of these functions so that you can apply them directly to a buffer without requiring a control.
1142
- #
1143
- # Category: Rich Text
1144
- #
1145
- # @wxrb_require USE_RICHTEXT
1146
- class RichTextListStyleDefinition < RichTextParagraphStyleDefinition
1147
-
1148
- # Constructor.
1149
- # @param name [String]
1150
- # @return [Wx::RTC::RichTextListStyleDefinition]
1151
- def initialize(name=('')) end
1152
-
1153
- # This function combines the given paragraph style with the list style's base attributes and level style matching the given indent, returning the combined attributes.
1116
+ # Category: Rich Text
1154
1117
  #
1155
- # If styleSheet is specified, the base style for this definition will also be included in the result.
1156
- # @param indent [Integer]
1157
- # @param paraStyle [Wx::RTC::RichTextAttr]
1158
- # @param styleSheet [Wx::RTC::RichTextStyleSheet]
1159
- # @return [Wx::RTC::RichTextAttr]
1160
- def combine_with_paragraph_style(indent, paraStyle, styleSheet=nil) end
1161
-
1162
- # This function finds the level (from 0 to 9) whose indentation attribute mostly closely matches indent (expressed in tenths of a millimetre).
1163
- # @param indent [Integer]
1164
- # @return [Integer]
1165
- def find_level_for_indent(indent) end
1166
-
1167
- # This function combines the list style's base attributes and the level style matching the given indent, returning the combined attributes.
1168
- #
1169
- # If styleSheet is specified, the base style for this definition will also be included in the result.
1170
- # @param indent [Integer]
1171
- # @param styleSheet [Wx::RTC::RichTextStyleSheet]
1172
- # @return [Wx::RTC::RichTextAttr]
1173
- def get_combined_style(indent, styleSheet=nil) end
1174
- alias_method :combined_style, :get_combined_style
1175
-
1176
- # This function combines the list style's base attributes and the style for the specified level, returning the combined attributes.
1177
- #
1178
- # If styleSheet is specified, the base style for this definition will also be included in the result.
1179
- # @param level [Integer]
1180
- # @param styleSheet [Wx::RTC::RichTextStyleSheet]
1181
- # @return [Wx::RTC::RichTextAttr]
1182
- def get_combined_style_for_level(level, styleSheet=nil) end
1183
- alias_method :combined_style_for_level, :get_combined_style_for_level
1184
-
1185
- # Returns the style for the given level.
1118
+ # @wxrb_require USE_RICHTEXT
1119
+ class RichTextParagraphStyleDefinition < RichTextStyleDefinition
1120
+
1121
+ # Constructor.
1122
+ # @param name [String]
1123
+ # @return [Wx::RTC::RichTextParagraphStyleDefinition]
1124
+ def initialize(name=('')) end
1125
+
1126
+ # Returns the style that should normally follow this style.
1127
+ # @return [Wx::String]
1128
+ def get_next_style; end
1129
+ alias_method :next_style, :get_next_style
1130
+
1131
+ # Sets the style that should normally follow this style.
1132
+ # @param name [String]
1133
+ # @return [void]
1134
+ def set_next_style(name) end
1135
+ alias_method :next_style=, :set_next_style
1136
+
1137
+ end # RichTextParagraphStyleDefinition
1138
+
1139
+ # This class represents a list style definition, usually added to a {Wx::RTC::RichTextStyleSheet}.
1186
1140
  #
1187
- # level is a number between 0 and 9.
1188
- # @param level [Integer]
1189
- # @return [Wx::RTC::RichTextAttr]
1190
- def get_level_attributes(level) end
1191
- alias_method :level_attributes, :get_level_attributes
1192
-
1193
- # Returns the number of levels.
1141
+ # The class inherits paragraph attributes from {Wx::RichTextStyleParagraphDefinition}, and adds 10 further attribute objects, one for each level of a list. When applying a list style to a paragraph, the list style's base and appropriate level attributes are merged with the paragraph's existing attributes.
1142
+ # You can apply a list style to one or more paragraphs using {Wx::RTC::RichTextCtrl#set_list_style}. You can also use the functions {Wx::RTC::RichTextCtrl#number_list}, {Wx::RTC::RichTextCtrl#promote_list} and {Wx::RTC::RichTextCtrl#clear_list_style}.
1143
+ # As usual, there are {Wx::RTC::RichTextBuffer} versions of these functions so that you can apply them directly to a buffer without requiring a control.
1194
1144
  #
1195
- # This is hard-wired to 10. Returns the style for the given level. level is a number between 0 and 9.
1196
- # @return [Integer]
1197
- def get_level_count; end
1198
- alias_method :level_count, :get_level_count
1199
-
1200
- # Returns true if the given level has numbered list attributes.
1201
- # @param level [Integer]
1202
- # @return [Boolean]
1203
- def is_numbered(level) end
1204
- alias_method :numbered?, :is_numbered
1205
-
1206
- # Sets the style for the given level.
1145
+ # Category: Rich Text
1207
1146
  #
1208
- # level is a number between 0 and 9. The first and most flexible form uses a {Wx::TextAttr} object, while the second form is for convenient setting of the most commonly-used attributes.
1209
- # @param level [Integer]
1210
- # @param attr [Wx::RTC::RichTextAttr]
1211
- # @return [void]
1212
- def set_level_attributes(level, attr) end
1147
+ # @wxrb_require USE_RICHTEXT
1148
+ class RichTextListStyleDefinition < RichTextParagraphStyleDefinition
1149
+
1150
+ # Constructor.
1151
+ # @param name [String]
1152
+ # @return [Wx::RTC::RichTextListStyleDefinition]
1153
+ def initialize(name=('')) end
1154
+
1155
+ # This function combines the given paragraph style with the list style's base attributes and level style matching the given indent, returning the combined attributes.
1156
+ #
1157
+ # If styleSheet is specified, the base style for this definition will also be included in the result.
1158
+ # @param indent [Integer]
1159
+ # @param paraStyle [Wx::RTC::RichTextAttr]
1160
+ # @param styleSheet [Wx::RTC::RichTextStyleSheet]
1161
+ # @return [Wx::RTC::RichTextAttr]
1162
+ def combine_with_paragraph_style(indent, paraStyle, styleSheet=nil) end
1163
+
1164
+ # This function finds the level (from 0 to 9) whose indentation attribute mostly closely matches indent (expressed in tenths of a millimetre).
1165
+ # @param indent [Integer]
1166
+ # @return [Integer]
1167
+ def find_level_for_indent(indent) end
1168
+
1169
+ # This function combines the list style's base attributes and the level style matching the given indent, returning the combined attributes.
1170
+ #
1171
+ # If styleSheet is specified, the base style for this definition will also be included in the result.
1172
+ # @param indent [Integer]
1173
+ # @param styleSheet [Wx::RTC::RichTextStyleSheet]
1174
+ # @return [Wx::RTC::RichTextAttr]
1175
+ def get_combined_style(indent, styleSheet=nil) end
1176
+ alias_method :combined_style, :get_combined_style
1177
+
1178
+ # This function combines the list style's base attributes and the style for the specified level, returning the combined attributes.
1179
+ #
1180
+ # If styleSheet is specified, the base style for this definition will also be included in the result.
1181
+ # @param level [Integer]
1182
+ # @param styleSheet [Wx::RTC::RichTextStyleSheet]
1183
+ # @return [Wx::RTC::RichTextAttr]
1184
+ def get_combined_style_for_level(level, styleSheet=nil) end
1185
+ alias_method :combined_style_for_level, :get_combined_style_for_level
1186
+
1187
+ # Returns the style for the given level.
1188
+ #
1189
+ # level is a number between 0 and 9.
1190
+ # @param level [Integer]
1191
+ # @return [Wx::RTC::RichTextAttr]
1192
+ def get_level_attributes(level) end
1193
+ alias_method :level_attributes, :get_level_attributes
1194
+
1195
+ # Returns the number of levels.
1196
+ #
1197
+ # This is hard-wired to 10. Returns the style for the given level. level is a number between 0 and 9.
1198
+ # @return [Integer]
1199
+ def get_level_count; end
1200
+ alias_method :level_count, :get_level_count
1201
+
1202
+ # Returns true if the given level has numbered list attributes.
1203
+ # @param level [Integer]
1204
+ # @return [Boolean]
1205
+ def is_numbered(level) end
1206
+ alias_method :numbered?, :is_numbered
1207
+
1208
+ # Sets the style for the given level.
1209
+ #
1210
+ # level is a number between 0 and 9. The first and most flexible form uses a {Wx::TextAttr} object, while the second form is for convenient setting of the most commonly-used attributes.
1211
+ # @param level [Integer]
1212
+ # @param attr [Wx::RTC::RichTextAttr]
1213
+ # @return [void]
1214
+ def set_level_attributes(level, attr) end
1215
+
1216
+ end # RichTextListStyleDefinition
1213
1217
 
1214
- end # RichTextListStyleDefinition
1215
-
1216
1218
 
1217
- end
1219
+ end
1220
+
1221
+ end