wxruby3 1.7.0 → 1.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (522) hide show
  1. checksums.yaml +4 -4
  2. data/INSTALL.md +27 -2
  3. data/README.md +15 -15
  4. data/ext/wxruby3/include/wxRubyApp.h +145 -46
  5. data/ext/wxruby3/include/wxruby-ComboPopup.h +25 -8
  6. data/ext/wxruby3/include/wxruby-GCTracking.h +262 -0
  7. data/ext/wxruby3/include/wxruby-MBConv.h +190 -0
  8. data/ext/wxruby3/include/wxruby-SharedEventHandler.h +183 -0
  9. data/ext/wxruby3/include/wxruby-SharedPtr.h +104 -0
  10. data/ext/wxruby3/include/wxruby-runtime.h +29 -0
  11. data/ext/wxruby3/swig/custom/rubytracking.swg +8 -22
  12. data/ext/wxruby3/swig/custom/wx_ruby_shared_ptr.i +434 -0
  13. data/ext/wxruby3/swig/custom/wx_shared_ptr.i +431 -0
  14. data/ext/wxruby3/swig/mark_free_impl.i +7 -132
  15. data/ext/wxruby3/swig/memory_management.i +8 -44
  16. data/ext/wxruby3/swig/wx.i +46 -73
  17. data/lib/wx/core/const.rb +0 -1
  18. data/lib/wx/core/context_help.rb +17 -0
  19. data/lib/wx/core/cursor.rb +1 -0
  20. data/lib/wx/core/helpcontrollerhelpprovider.rb +10 -2
  21. data/lib/wx/core/mbconv.rb +11 -0
  22. data/lib/wx/core/media_ctrl.rb +31 -0
  23. data/lib/wx/core/top_level_window.rb +7 -0
  24. data/lib/wx/core.rb +6 -0
  25. data/lib/wx/doc/art_provider.rb +17 -0
  26. data/lib/wx/doc/context_help.rb +42 -0
  27. data/lib/wx/doc/core.rb +0 -5
  28. data/lib/wx/doc/functions.rb +10 -0
  29. data/lib/wx/doc/html/html_help_controller.rb +23 -1
  30. data/lib/wx/doc/mbconv.rb +108 -0
  31. data/lib/wx/doc/rt/shared_event_handler.rb +49 -0
  32. data/lib/wx/doc/rt/thread_event.rb +28 -0
  33. data/lib/wx/doc/stream.rb +7 -3
  34. data/lib/wx/doc/webview.rb +40 -0
  35. data/lib/wx/helpers.rb +1 -1
  36. data/lib/wx/html/htmlhelpcontroller.rb +10 -0
  37. data/lib/wx/keyword_defs.rb +11 -0
  38. data/lib/wx/rt/require.rb +8 -0
  39. data/lib/wx/rt/thread_event.rb +14 -0
  40. data/lib/wx/rt.rb +16 -0
  41. data/lib/wx/version.rb +1 -1
  42. data/lib/wx/web/require.rb +8 -0
  43. data/lib/wx/web/webview.rb +106 -0
  44. data/lib/wx/web.rb +17 -0
  45. data/lib/wx/wxruby/cmd/setup.rb +15 -0
  46. data/lib/wx/wxruby/cmd/test.rb +8 -2
  47. data/lib/wx.rb +2 -0
  48. data/rakelib/configure.rb +24 -0
  49. data/rakelib/gem.rb +3 -2
  50. data/rakelib/install.rb +54 -27
  51. data/rakelib/lib/config/macosx.rb +7 -5
  52. data/rakelib/lib/config/mingw.rb +66 -5
  53. data/rakelib/lib/config/pkgman/linux.rb +4 -2
  54. data/rakelib/lib/config/pkgman/mingw.rb +1 -1
  55. data/rakelib/lib/config/unixish.rb +4 -2
  56. data/rakelib/lib/config.rb +37 -3
  57. data/rakelib/lib/core/include/client_data.inc +38 -17
  58. data/rakelib/lib/core/include/funcall.inc +1 -1
  59. data/rakelib/lib/core/include/swigdirector.inc +3 -3
  60. data/rakelib/lib/core/include/swigrubyrun.inc +14 -26
  61. data/rakelib/lib/core/package.rb +0 -2
  62. data/rakelib/lib/director/app.rb +1 -8
  63. data/rakelib/lib/director/art_provider.rb +7 -3
  64. data/rakelib/lib/director/comboctrl.rb +0 -7
  65. data/rakelib/lib/director/context_help_button.rb +35 -2
  66. data/rakelib/lib/director/derived_dc.rb +41 -32
  67. data/rakelib/lib/director/editable_listbox.rb +10 -8
  68. data/rakelib/lib/director/event_handler.rb +32 -28
  69. data/rakelib/lib/director/fs_file.rb +38 -10
  70. data/rakelib/lib/director/functions.rb +8 -0
  71. data/rakelib/lib/director/grid_cell_attr.rb +1 -3
  72. data/rakelib/lib/director/grid_cell_editor.rb +14 -12
  73. data/rakelib/lib/director/grid_cell_renderer.rb +11 -8
  74. data/rakelib/lib/director/grid_ctrl.rb +140 -121
  75. data/rakelib/lib/director/help_controller.rb +70 -2
  76. data/rakelib/lib/director/mb_conv.rb +30 -0
  77. data/rakelib/lib/director/menu.rb +92 -42
  78. data/rakelib/lib/director/menu_bar.rb +84 -45
  79. data/rakelib/lib/director/menu_item.rb +2 -2
  80. data/rakelib/lib/director/persistence_manager.rb +3 -2
  81. data/rakelib/lib/director/preview_frame.rb +2 -2
  82. data/rakelib/lib/director/ribbon_page.rb +11 -0
  83. data/rakelib/lib/director/richtext_buffer.rb +5 -2
  84. data/rakelib/lib/director/shared_evt_handler.rb +30 -0
  85. data/rakelib/lib/director/sizer.rb +8 -17
  86. data/rakelib/lib/director/sizer_item.rb +3 -4
  87. data/rakelib/lib/director/task_bar_icon.rb +7 -7
  88. data/rakelib/lib/director/thread_event.rb +33 -0
  89. data/rakelib/lib/director/top_level_window.rb +12 -4
  90. data/rakelib/lib/director/validator.rb +3 -1
  91. data/rakelib/lib/director/variant.rb +16 -12
  92. data/rakelib/lib/director/webview.rb +166 -0
  93. data/rakelib/lib/director/webview_event.rb +37 -0
  94. data/rakelib/lib/director/webview_handler.rb +63 -0
  95. data/rakelib/lib/generate/doc/thread_event.yaml +20 -0
  96. data/rakelib/lib/generate/doc/web_view.yaml +135 -0
  97. data/rakelib/lib/generate/doc/web_view_event.yaml +38 -0
  98. data/rakelib/lib/generate/doc/web_view_handler.yaml +58 -0
  99. data/rakelib/lib/specs/interfaces.rb +14 -2
  100. data/rakelib/lib/typemap/common.rb +34 -1
  101. data/rakelib/lib/typemap/mb_conv.rb +58 -0
  102. data/rakelib/prepost.rake +23 -31
  103. data/rakelib/prepost.rb +20 -0
  104. data/samples/event/threaded.rb +295 -42
  105. data/samples/event/tn_threaded.png +0 -0
  106. data/samples/help/doc/back.gif +0 -0
  107. data/samples/help/doc/contents.gif +0 -0
  108. data/samples/help/doc/cshelp.txt +9 -0
  109. data/samples/help/doc/doc.chm +0 -0
  110. data/samples/help/doc/doc.cnt +8 -0
  111. data/samples/help/doc/doc.h +7 -0
  112. data/samples/help/doc/doc.hhc +40 -0
  113. data/samples/help/doc/doc.hhk +31 -0
  114. data/samples/help/doc/doc.hhp +33 -0
  115. data/samples/help/doc/doc.hpj +21 -0
  116. data/samples/help/doc/doc.htm +27 -0
  117. data/samples/help/doc/doc1.htm +24 -0
  118. data/samples/help/doc/doc2.htm +12 -0
  119. data/samples/help/doc/doc3.htm +12 -0
  120. data/samples/help/doc/doc4.htm +12 -0
  121. data/samples/help/doc/doc5.htm +14 -0
  122. data/samples/help/doc/forward.gif +0 -0
  123. data/samples/help/doc/up.gif +0 -0
  124. data/samples/help/doc.chm +0 -0
  125. data/samples/help/doc.chw +0 -0
  126. data/samples/help/doc.zip +0 -0
  127. data/samples/help/help.rb +352 -0
  128. data/samples/help/tn_help.png +0 -0
  129. data/samples/webview/handler_advanced.html +55 -0
  130. data/samples/webview/tn_webview.png +0 -0
  131. data/samples/webview/webview.rb +1264 -0
  132. data/tests/assets/handler_advanced.html +55 -0
  133. data/tests/assets/test.zip +0 -0
  134. data/tests/lib/text_entry_tests.rb +2 -2
  135. data/tests/lib/wxapp_runner.rb +40 -0
  136. data/tests/lib/wxframe_runner.rb +17 -2
  137. data/tests/test_art.rb +8 -8
  138. data/tests/test_clipboard.rb +4 -4
  139. data/tests/test_config.rb +6 -6
  140. data/tests/test_exceptions.rb +8 -6
  141. data/tests/test_ext_controls.rb +3 -3
  142. data/tests/test_file_dialog.rb +5 -5
  143. data/tests/test_font.rb +7 -7
  144. data/tests/test_grid_ctrl.rb +133 -0
  145. data/tests/test_help.rb +88 -0
  146. data/tests/test_intl.rb +1 -1
  147. data/tests/test_media_ctrl.rb +14 -6
  148. data/tests/test_menu.rb +94 -86
  149. data/tests/test_persistence.rb +1 -1
  150. data/tests/test_proof_check.rb +5 -5
  151. data/tests/test_propgrid.rb +1 -1
  152. data/tests/test_shared_event_handler.rb +141 -0
  153. data/tests/test_std_controls.rb +5 -5
  154. data/tests/test_webview.rb +492 -0
  155. data/tests/test_window.rb +3 -3
  156. metadata +66 -368
  157. data/assets/repo-social-preview.odg +0 -0
  158. data/assets/repo-social-preview.xcf +0 -0
  159. data/lib/wx/aui/events/evt_list.rb +0 -148
  160. data/lib/wx/core/events/evt_list.rb +0 -1458
  161. data/lib/wx/core/font/encoding.rb +0 -113
  162. data/lib/wx/doc/gen/about_dialog_info.rb +0 -330
  163. data/lib/wx/doc/gen/accelerator.rb +0 -178
  164. data/lib/wx/doc/gen/activity_indicator.rb +0 -83
  165. data/lib/wx/doc/gen/affine_matrix2d.rb +0 -284
  166. data/lib/wx/doc/gen/animation.rb +0 -275
  167. data/lib/wx/doc/gen/animation_ctrl.rb +0 -300
  168. data/lib/wx/doc/gen/any_button.rb +0 -191
  169. data/lib/wx/doc/gen/app.rb +0 -463
  170. data/lib/wx/doc/gen/app_traits.rb +0 -396
  171. data/lib/wx/doc/gen/art_provider.rb +0 -605
  172. data/lib/wx/doc/gen/aui/aui_dock_art.rb +0 -455
  173. data/lib/wx/doc/gen/aui/aui_floating_frame.rb +0 -54
  174. data/lib/wx/doc/gen/aui/aui_manager.rb +0 -847
  175. data/lib/wx/doc/gen/aui/aui_manager_event.rb +0 -131
  176. data/lib/wx/doc/gen/aui/aui_mdi_child_frame.rb +0 -180
  177. data/lib/wx/doc/gen/aui/aui_mdi_client_window.rb +0 -59
  178. data/lib/wx/doc/gen/aui/aui_mdi_parent_frame.rb +0 -130
  179. data/lib/wx/doc/gen/aui/aui_notebook.rb +0 -631
  180. data/lib/wx/doc/gen/aui/aui_notebook_event.rb +0 -233
  181. data/lib/wx/doc/gen/aui/aui_pane_info.rb +0 -769
  182. data/lib/wx/doc/gen/aui/aui_tab_art.rb +0 -352
  183. data/lib/wx/doc/gen/aui/aui_tab_ctrl.rb +0 -14
  184. data/lib/wx/doc/gen/aui/aui_tool_bar.rb +0 -510
  185. data/lib/wx/doc/gen/aui/aui_tool_bar_art.rb +0 -340
  186. data/lib/wx/doc/gen/aui/aui_tool_bar_event.rb +0 -244
  187. data/lib/wx/doc/gen/aui/aui_tool_bar_item.rb +0 -257
  188. data/lib/wx/doc/gen/aui/event_list.rb +0 -179
  189. data/lib/wx/doc/gen/banner_window.rb +0 -124
  190. data/lib/wx/doc/gen/bitmap.rb +0 -731
  191. data/lib/wx/doc/gen/bitmap_button.rb +0 -123
  192. data/lib/wx/doc/gen/bitmap_combo_box.rb +0 -221
  193. data/lib/wx/doc/gen/book_ctrl_base.rb +0 -273
  194. data/lib/wx/doc/gen/book_ctrl_event.rb +0 -66
  195. data/lib/wx/doc/gen/box_sizer.rb +0 -85
  196. data/lib/wx/doc/gen/brush.rb +0 -251
  197. data/lib/wx/doc/gen/busy_info.rb +0 -157
  198. data/lib/wx/doc/gen/button.rb +0 -182
  199. data/lib/wx/doc/gen/calculate_layout_event.rb +0 -62
  200. data/lib/wx/doc/gen/calendar_ctrl.rb +0 -505
  201. data/lib/wx/doc/gen/calendar_date_attr.rb +0 -138
  202. data/lib/wx/doc/gen/calendar_event.rb +0 -147
  203. data/lib/wx/doc/gen/caret.rb +0 -97
  204. data/lib/wx/doc/gen/check_box.rb +0 -175
  205. data/lib/wx/doc/gen/check_list_box.rb +0 -121
  206. data/lib/wx/doc/gen/choice.rb +0 -175
  207. data/lib/wx/doc/gen/choicebook.rb +0 -116
  208. data/lib/wx/doc/gen/client_dc.rb +0 -43
  209. data/lib/wx/doc/gen/clipboard.rb +0 -144
  210. data/lib/wx/doc/gen/collapsible_pane.rb +0 -138
  211. data/lib/wx/doc/gen/collapsible_pane_event.rb +0 -46
  212. data/lib/wx/doc/gen/colour.rb +0 -333
  213. data/lib/wx/doc/gen/colour_dialog.rb +0 -190
  214. data/lib/wx/doc/gen/colour_picker_ctrl.rb +0 -110
  215. data/lib/wx/doc/gen/colour_picker_event.rb +0 -77
  216. data/lib/wx/doc/gen/combo_box.rb +0 -292
  217. data/lib/wx/doc/gen/combo_ctrl.rb +0 -662
  218. data/lib/wx/doc/gen/command_link_button.rb +0 -134
  219. data/lib/wx/doc/gen/config_base.rb +0 -10
  220. data/lib/wx/doc/gen/context_help_button.rb +0 -109
  221. data/lib/wx/doc/gen/control.rb +0 -277
  222. data/lib/wx/doc/gen/control_with_items.rb +0 -253
  223. data/lib/wx/doc/gen/core.rb +0 -45
  224. data/lib/wx/doc/gen/credential_entry_dialog.rb +0 -137
  225. data/lib/wx/doc/gen/cursor.rb +0 -193
  226. data/lib/wx/doc/gen/data_format.rb +0 -85
  227. data/lib/wx/doc/gen/data_object.rb +0 -436
  228. data/lib/wx/doc/gen/data_object_simple_base.rb +0 -10
  229. data/lib/wx/doc/gen/date_event.rb +0 -49
  230. data/lib/wx/doc/gen/date_picker_ctrl.rb +0 -161
  231. data/lib/wx/doc/gen/dc.rb +0 -1631
  232. data/lib/wx/doc/gen/dc_overlay.rb +0 -102
  233. data/lib/wx/doc/gen/defs.rb +0 -2802
  234. data/lib/wx/doc/gen/dial_up_event.rb +0 -45
  235. data/lib/wx/doc/gen/dial_up_manager.rb +0 -149
  236. data/lib/wx/doc/gen/dialog.rb +0 -541
  237. data/lib/wx/doc/gen/dir_dialog.rb +0 -164
  238. data/lib/wx/doc/gen/dir_filter_list_ctrl.rb +0 -90
  239. data/lib/wx/doc/gen/dir_picker_ctrl.rb +0 -125
  240. data/lib/wx/doc/gen/display.rb +0 -238
  241. data/lib/wx/doc/gen/drag_drop.rb +0 -299
  242. data/lib/wx/doc/gen/drag_image.rb +0 -116
  243. data/lib/wx/doc/gen/editable_list_box.rb +0 -109
  244. data/lib/wx/doc/gen/event.rb +0 -990
  245. data/lib/wx/doc/gen/event_blocker.rb +0 -50
  246. data/lib/wx/doc/gen/event_filter.rb +0 -92
  247. data/lib/wx/doc/gen/event_list.rb +0 -1644
  248. data/lib/wx/doc/gen/events.rb +0 -2809
  249. data/lib/wx/doc/gen/evt_handler.rb +0 -229
  250. data/lib/wx/doc/gen/ext_help_controller.rb +0 -109
  251. data/lib/wx/doc/gen/file_ctrl.rb +0 -231
  252. data/lib/wx/doc/gen/file_ctrl_event.rb +0 -83
  253. data/lib/wx/doc/gen/file_dialog.rb +0 -353
  254. data/lib/wx/doc/gen/file_dialog_custom_control.rb +0 -165
  255. data/lib/wx/doc/gen/file_dialog_customize_hook.rb +0 -158
  256. data/lib/wx/doc/gen/file_dir_picker_event.rb +0 -100
  257. data/lib/wx/doc/gen/file_picker_ctrl.rb +0 -132
  258. data/lib/wx/doc/gen/file_system.rb +0 -232
  259. data/lib/wx/doc/gen/find_dialog_event.rb +0 -126
  260. data/lib/wx/doc/gen/find_replace_data.rb +0 -60
  261. data/lib/wx/doc/gen/find_replace_dialog.rb +0 -58
  262. data/lib/wx/doc/gen/flex_grid_sizer.rb +0 -199
  263. data/lib/wx/doc/gen/font.rb +0 -1379
  264. data/lib/wx/doc/gen/font_data.rb +0 -151
  265. data/lib/wx/doc/gen/font_dialog.rb +0 -88
  266. data/lib/wx/doc/gen/font_picker_ctrl.rb +0 -143
  267. data/lib/wx/doc/gen/font_picker_event.rb +0 -65
  268. data/lib/wx/doc/gen/frame.rb +0 -352
  269. data/lib/wx/doc/gen/fs_file.rb +0 -337
  270. data/lib/wx/doc/gen/functions.rb +0 -10
  271. data/lib/wx/doc/gen/gauge.rb +0 -157
  272. data/lib/wx/doc/gen/gb_sizer_item.rb +0 -68
  273. data/lib/wx/doc/gen/gcdc.rb +0 -46
  274. data/lib/wx/doc/gen/gdi_common.rb +0 -1271
  275. data/lib/wx/doc/gen/gdi_object.rb +0 -31
  276. data/lib/wx/doc/gen/generic_about_dialog.rb +0 -140
  277. data/lib/wx/doc/gen/generic_dir_ctrl.rb +0 -223
  278. data/lib/wx/doc/gen/geometry.rb +0 -661
  279. data/lib/wx/doc/gen/graphics_context.rb +0 -1184
  280. data/lib/wx/doc/gen/graphics_object.rb +0 -750
  281. data/lib/wx/doc/gen/grid/event_list.rb +0 -191
  282. data/lib/wx/doc/gen/grid/grid_cell_activatable_editor.rb +0 -40
  283. data/lib/wx/doc/gen/grid/grid_cell_attr.rb +0 -280
  284. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_editor.rb +0 -35
  285. data/lib/wx/doc/gen/grid/grid_cell_auto_wrap_string_renderer.rb +0 -37
  286. data/lib/wx/doc/gen/grid/grid_cell_bool_editor.rb +0 -49
  287. data/lib/wx/doc/gen/grid/grid_cell_bool_renderer.rb +0 -35
  288. data/lib/wx/doc/gen/grid/grid_cell_choice_editor.rb +0 -46
  289. data/lib/wx/doc/gen/grid/grid_cell_date_editor.rb +0 -38
  290. data/lib/wx/doc/gen/grid/grid_cell_date_renderer.rb +0 -45
  291. data/lib/wx/doc/gen/grid/grid_cell_date_time_renderer.rb +0 -40
  292. data/lib/wx/doc/gen/grid/grid_cell_editor.rb +0 -197
  293. data/lib/wx/doc/gen/grid/grid_cell_enum_editor.rb +0 -39
  294. data/lib/wx/doc/gen/grid/grid_cell_enum_renderer.rb +0 -44
  295. data/lib/wx/doc/gen/grid/grid_cell_float_editor.rb +0 -45
  296. data/lib/wx/doc/gen/grid/grid_cell_float_renderer.rb +0 -79
  297. data/lib/wx/doc/gen/grid/grid_cell_number_editor.rb +0 -46
  298. data/lib/wx/doc/gen/grid/grid_cell_number_renderer.rb +0 -35
  299. data/lib/wx/doc/gen/grid/grid_cell_renderer.rb +0 -108
  300. data/lib/wx/doc/gen/grid/grid_cell_string_renderer.rb +0 -35
  301. data/lib/wx/doc/gen/grid/grid_cell_text_editor.rb +0 -49
  302. data/lib/wx/doc/gen/grid/grid_ctrl.rb +0 -3002
  303. data/lib/wx/doc/gen/grid/grid_editor_created_event.rb +0 -95
  304. data/lib/wx/doc/gen/grid/grid_event.rb +0 -129
  305. data/lib/wx/doc/gen/grid/grid_range_select_event.rb +0 -104
  306. data/lib/wx/doc/gen/grid/grid_size_event.rb +0 -85
  307. data/lib/wx/doc/gen/grid/grid_string_table.rb +0 -142
  308. data/lib/wx/doc/gen/grid/grid_table_base.rb +0 -317
  309. data/lib/wx/doc/gen/grid/grid_table_message.rb +0 -81
  310. data/lib/wx/doc/gen/grid_bag_sizer.rb +0 -323
  311. data/lib/wx/doc/gen/grid_sizer.rb +0 -195
  312. data/lib/wx/doc/gen/gui_event_loop.rb +0 -159
  313. data/lib/wx/doc/gen/h_scrolled_window.rb +0 -562
  314. data/lib/wx/doc/gen/header_ctrl.rb +0 -880
  315. data/lib/wx/doc/gen/header_ctrl_event.rb +0 -133
  316. data/lib/wx/doc/gen/help_controller.rb +0 -195
  317. data/lib/wx/doc/gen/help_provider.rb +0 -98
  318. data/lib/wx/doc/gen/html/event_list.rb +0 -38
  319. data/lib/wx/doc/gen/html/html_cell.rb +0 -536
  320. data/lib/wx/doc/gen/html/html_cell_event.rb +0 -69
  321. data/lib/wx/doc/gen/html/html_data_object.rb +0 -42
  322. data/lib/wx/doc/gen/html/html_easy_printing.rb +0 -203
  323. data/lib/wx/doc/gen/html/html_help_controller.rb +0 -340
  324. data/lib/wx/doc/gen/html/html_help_data.rb +0 -159
  325. data/lib/wx/doc/gen/html/html_help_window.rb +0 -258
  326. data/lib/wx/doc/gen/html/html_link_event.rb +0 -41
  327. data/lib/wx/doc/gen/html/html_list_box.rb +0 -346
  328. data/lib/wx/doc/gen/html/html_printout.rb +0 -109
  329. data/lib/wx/doc/gen/html/html_window.rb +0 -461
  330. data/lib/wx/doc/gen/hyperlink_ctrl.rb +0 -311
  331. data/lib/wx/doc/gen/hyperlink_event.rb +0 -44
  332. data/lib/wx/doc/gen/icon.rb +0 -267
  333. data/lib/wx/doc/gen/icon_location.rb +0 -40
  334. data/lib/wx/doc/gen/image.rb +0 -1371
  335. data/lib/wx/doc/gen/image_list.rb +0 -168
  336. data/lib/wx/doc/gen/info_bar.rb +0 -195
  337. data/lib/wx/doc/gen/keyboard_state.rb +0 -140
  338. data/lib/wx/doc/gen/list_box.rb +0 -304
  339. data/lib/wx/doc/gen/list_ctrl.rb +0 -1774
  340. data/lib/wx/doc/gen/list_event.rb +0 -208
  341. data/lib/wx/doc/gen/listbook.rb +0 -116
  342. data/lib/wx/doc/gen/locale.rb +0 -4293
  343. data/lib/wx/doc/gen/log.rb +0 -603
  344. data/lib/wx/doc/gen/mdi_client_window.rb +0 -47
  345. data/lib/wx/doc/gen/mdi_frame.rb +0 -324
  346. data/lib/wx/doc/gen/media_ctrl.rb +0 -269
  347. data/lib/wx/doc/gen/media_event.rb +0 -117
  348. data/lib/wx/doc/gen/memory_dc.rb +0 -174
  349. data/lib/wx/doc/gen/menu.rb +0 -509
  350. data/lib/wx/doc/gen/menu_bar.rb +0 -287
  351. data/lib/wx/doc/gen/menu_item.rb +0 -362
  352. data/lib/wx/doc/gen/message_dialog.rb +0 -238
  353. data/lib/wx/doc/gen/mini_frame.rb +0 -108
  354. data/lib/wx/doc/gen/mirror_dc.rb +0 -22
  355. data/lib/wx/doc/gen/mouse_state.rb +0 -150
  356. data/lib/wx/doc/gen/multi_choice_dialog.rb +0 -80
  357. data/lib/wx/doc/gen/non_owned_window.rb +0 -49
  358. data/lib/wx/doc/gen/notebook.rb +0 -278
  359. data/lib/wx/doc/gen/num_validator.rb +0 -37
  360. data/lib/wx/doc/gen/number_entry_dialog.rb +0 -93
  361. data/lib/wx/doc/gen/object.rb +0 -59
  362. data/lib/wx/doc/gen/owner_drawn_combo_box.rb +0 -395
  363. data/lib/wx/doc/gen/paint_dc.rb +0 -27
  364. data/lib/wx/doc/gen/palette.rb +0 -92
  365. data/lib/wx/doc/gen/panel.rb +0 -127
  366. data/lib/wx/doc/gen/pen.rb +0 -511
  367. data/lib/wx/doc/gen/persistence_manager.rb +0 -135
  368. data/lib/wx/doc/gen/persistent_object.rb +0 -52
  369. data/lib/wx/doc/gen/persistent_window.rb +0 -241
  370. data/lib/wx/doc/gen/pg/event_list.rb +0 -106
  371. data/lib/wx/doc/gen/pg/numeric_property_validator.rb +0 -54
  372. data/lib/wx/doc/gen/pg/pg_array_editor_dialog.rb +0 -292
  373. data/lib/wx/doc/gen/pg/pg_cell.rb +0 -177
  374. data/lib/wx/doc/gen/pg/pg_editor.rb +0 -721
  375. data/lib/wx/doc/gen/pg/pg_multi_button.rb +0 -152
  376. data/lib/wx/doc/gen/pg/pg_properties.rb +0 -2829
  377. data/lib/wx/doc/gen/pg/pg_property.rb +0 -2078
  378. data/lib/wx/doc/gen/pg/pg_validation_info.rb +0 -344
  379. data/lib/wx/doc/gen/pg/property_grid.rb +0 -740
  380. data/lib/wx/doc/gen/pg/property_grid_event.rb +0 -184
  381. data/lib/wx/doc/gen/pg/property_grid_interface.rb +0 -1098
  382. data/lib/wx/doc/gen/pg/property_grid_manager.rb +0 -415
  383. data/lib/wx/doc/gen/pg/property_grid_page.rb +0 -354
  384. data/lib/wx/doc/gen/pg/property_grid_page_state.rb +0 -165
  385. data/lib/wx/doc/gen/picker_base.rb +0 -152
  386. data/lib/wx/doc/gen/platform_info.rb +0 -622
  387. data/lib/wx/doc/gen/popup_window.rb +0 -107
  388. data/lib/wx/doc/gen/progress_dialog.rb +0 -100
  389. data/lib/wx/doc/gen/property_sheet_dialog.rb +0 -216
  390. data/lib/wx/doc/gen/prt/event_list.rb +0 -17
  391. data/lib/wx/doc/gen/prt/page_setup_dialog.rb +0 -44
  392. data/lib/wx/doc/gen/prt/post_script_dc.rb +0 -30
  393. data/lib/wx/doc/gen/prt/preview_frame.rb +0 -78
  394. data/lib/wx/doc/gen/prt/print_abort_dialog.rb +0 -151
  395. data/lib/wx/doc/gen/prt/print_data.rb +0 -804
  396. data/lib/wx/doc/gen/prt/print_dialog.rb +0 -55
  397. data/lib/wx/doc/gen/prt/printer.rb +0 -518
  398. data/lib/wx/doc/gen/prt/printer_dc.rb +0 -37
  399. data/lib/wx/doc/gen/query_layout_info_event.rb +0 -106
  400. data/lib/wx/doc/gen/radio_box.rb +0 -306
  401. data/lib/wx/doc/gen/radio_button.rb +0 -159
  402. data/lib/wx/doc/gen/rbn/event_list.rb +0 -136
  403. data/lib/wx/doc/gen/rbn/ribbon_art_provider.rb +0 -1132
  404. data/lib/wx/doc/gen/rbn/ribbon_bar.rb +0 -308
  405. data/lib/wx/doc/gen/rbn/ribbon_bar_event.rb +0 -45
  406. data/lib/wx/doc/gen/rbn/ribbon_button_bar.rb +0 -458
  407. data/lib/wx/doc/gen/rbn/ribbon_button_bar_event.rb +0 -63
  408. data/lib/wx/doc/gen/rbn/ribbon_control.rb +0 -143
  409. data/lib/wx/doc/gen/rbn/ribbon_gallery.rb +0 -229
  410. data/lib/wx/doc/gen/rbn/ribbon_gallery_event.rb +0 -55
  411. data/lib/wx/doc/gen/rbn/ribbon_page.rb +0 -174
  412. data/lib/wx/doc/gen/rbn/ribbon_panel.rb +0 -270
  413. data/lib/wx/doc/gen/rbn/ribbon_panel_event.rb +0 -45
  414. data/lib/wx/doc/gen/rbn/ribbon_tool_bar.rb +0 -360
  415. data/lib/wx/doc/gen/rbn/ribbon_tool_bar_event.rb +0 -42
  416. data/lib/wx/doc/gen/rearrange_ctrl.rb +0 -78
  417. data/lib/wx/doc/gen/rearrange_list.rb +0 -123
  418. data/lib/wx/doc/gen/region.rb +0 -380
  419. data/lib/wx/doc/gen/region_iterator.rb +0 -76
  420. data/lib/wx/doc/gen/rich_tool_tip.rb +0 -154
  421. data/lib/wx/doc/gen/rtc/event_list.rb +0 -125
  422. data/lib/wx/doc/gen/rtc/rich_text_box.rb +0 -445
  423. data/lib/wx/doc/gen/rtc/rich_text_buffer.rb +0 -1188
  424. data/lib/wx/doc/gen/rtc/rich_text_buffer_data_object.rb +0 -41
  425. data/lib/wx/doc/gen/rtc/rich_text_composite_object.rb +0 -538
  426. data/lib/wx/doc/gen/rtc/rich_text_ctrl.rb +0 -2103
  427. data/lib/wx/doc/gen/rtc/rich_text_event.rb +0 -173
  428. data/lib/wx/doc/gen/rtc/rich_text_file_handler.rb +0 -181
  429. data/lib/wx/doc/gen/rtc/rich_text_formatting_dialog.rb +0 -319
  430. data/lib/wx/doc/gen/rtc/rich_text_header_footer_data.rb +0 -193
  431. data/lib/wx/doc/gen/rtc/rich_text_html_handler.rb +0 -102
  432. data/lib/wx/doc/gen/rtc/rich_text_image.rb +0 -337
  433. data/lib/wx/doc/gen/rtc/rich_text_object.rb +0 -2922
  434. data/lib/wx/doc/gen/rtc/rich_text_paragraph_layout_box.rb +0 -1240
  435. data/lib/wx/doc/gen/rtc/rich_text_printing.rb +0 -258
  436. data/lib/wx/doc/gen/rtc/rich_text_style_list_box.rb +0 -344
  437. data/lib/wx/doc/gen/rtc/rich_text_style_organiser_dialog.rb +0 -227
  438. data/lib/wx/doc/gen/rtc/rich_text_xml_handler.rb +0 -59
  439. data/lib/wx/doc/gen/rtc/symbol_picker_dialog.rb +0 -169
  440. data/lib/wx/doc/gen/sash_event.rb +0 -147
  441. data/lib/wx/doc/gen/sash_layout_window.rb +0 -232
  442. data/lib/wx/doc/gen/sash_window.rb +0 -171
  443. data/lib/wx/doc/gen/scaled_dc.rb +0 -10
  444. data/lib/wx/doc/gen/screen_dc.rb +0 -30
  445. data/lib/wx/doc/gen/scroll_bar.rb +0 -204
  446. data/lib/wx/doc/gen/scrolled_canvas.rb +0 -410
  447. data/lib/wx/doc/gen/scrolled_control.rb +0 -410
  448. data/lib/wx/doc/gen/scrolled_window.rb +0 -430
  449. data/lib/wx/doc/gen/search_ctrl.rb +0 -159
  450. data/lib/wx/doc/gen/secret_store.rb +0 -116
  451. data/lib/wx/doc/gen/simplebook.rb +0 -110
  452. data/lib/wx/doc/gen/single_choice_dialog.rb +0 -89
  453. data/lib/wx/doc/gen/sizer.rb +0 -945
  454. data/lib/wx/doc/gen/sizer_item.rb +0 -244
  455. data/lib/wx/doc/gen/slider.rb +0 -342
  456. data/lib/wx/doc/gen/spin_button.rb +0 -157
  457. data/lib/wx/doc/gen/spin_ctrl.rb +0 -231
  458. data/lib/wx/doc/gen/spin_ctrl_double.rb +0 -192
  459. data/lib/wx/doc/gen/spin_double_event.rb +0 -55
  460. data/lib/wx/doc/gen/spin_event.rb +0 -51
  461. data/lib/wx/doc/gen/splash_screen.rb +0 -113
  462. data/lib/wx/doc/gen/splitter_event.rb +0 -99
  463. data/lib/wx/doc/gen/splitter_window.rb +0 -498
  464. data/lib/wx/doc/gen/static_bitmap.rb +0 -256
  465. data/lib/wx/doc/gen/static_box.rb +0 -180
  466. data/lib/wx/doc/gen/static_box_sizer.rb +0 -85
  467. data/lib/wx/doc/gen/static_line.rb +0 -83
  468. data/lib/wx/doc/gen/static_text.rb +0 -127
  469. data/lib/wx/doc/gen/status_bar.rb +0 -290
  470. data/lib/wx/doc/gen/stc/event_list.rb +0 -221
  471. data/lib/wx/doc/gen/stc/styled_text_ctrl.rb +0 -4474
  472. data/lib/wx/doc/gen/stc/styled_text_event.rb +0 -8762
  473. data/lib/wx/doc/gen/std_dialog_button_sizer.rb +0 -129
  474. data/lib/wx/doc/gen/svg_file_dc.rb +0 -164
  475. data/lib/wx/doc/gen/system_options.rb +0 -129
  476. data/lib/wx/doc/gen/system_settings.rb +0 -507
  477. data/lib/wx/doc/gen/task_bar_icon.rb +0 -127
  478. data/lib/wx/doc/gen/task_bar_icon_event.rb +0 -88
  479. data/lib/wx/doc/gen/text_attr.rb +0 -756
  480. data/lib/wx/doc/gen/text_ctrl.rb +0 -1033
  481. data/lib/wx/doc/gen/text_entry.rb +0 -441
  482. data/lib/wx/doc/gen/text_entry_dialog.rb +0 -220
  483. data/lib/wx/doc/gen/text_validator.rb +0 -245
  484. data/lib/wx/doc/gen/time_picker_ctrl.rb +0 -128
  485. data/lib/wx/doc/gen/timer.rb +0 -119
  486. data/lib/wx/doc/gen/timer_event.rb +0 -68
  487. data/lib/wx/doc/gen/tip_provider.rb +0 -63
  488. data/lib/wx/doc/gen/tip_window.rb +0 -51
  489. data/lib/wx/doc/gen/toggle_button.rb +0 -182
  490. data/lib/wx/doc/gen/tool_bar.rb +0 -890
  491. data/lib/wx/doc/gen/tool_tip.rb +0 -86
  492. data/lib/wx/doc/gen/toolbook.rb +0 -118
  493. data/lib/wx/doc/gen/top_level_window.rb +0 -497
  494. data/lib/wx/doc/gen/tree_ctrl.rb +0 -1052
  495. data/lib/wx/doc/gen/tree_event.rb +0 -127
  496. data/lib/wx/doc/gen/treebook.rb +0 -180
  497. data/lib/wx/doc/gen/ui_action_simulator.rb +0 -109
  498. data/lib/wx/doc/gen/utils.rb +0 -273
  499. data/lib/wx/doc/gen/v_list_box.rb +0 -272
  500. data/lib/wx/doc/gen/v_scrolled_canvas.rb +0 -195
  501. data/lib/wx/doc/gen/v_scrolled_window.rb +0 -191
  502. data/lib/wx/doc/gen/validator.rb +0 -68
  503. data/lib/wx/doc/gen/variant.rb +0 -294
  504. data/lib/wx/doc/gen/window.rb +0 -2917
  505. data/lib/wx/doc/gen/window_dc.rb +0 -38
  506. data/lib/wx/doc/gen/window_disabler.rb +0 -30
  507. data/lib/wx/doc/gen/with_images.rb +0 -84
  508. data/lib/wx/doc/gen/wizard.rb +0 -257
  509. data/lib/wx/doc/gen/wizard_event.rb +0 -113
  510. data/lib/wx/doc/gen/wizard_page.rb +0 -65
  511. data/lib/wx/doc/gen/wizard_page_simple.rb +0 -88
  512. data/lib/wx/doc/gen/wrap_sizer.rb +0 -79
  513. data/lib/wx/doc/gen/xml_node.rb +0 -316
  514. data/lib/wx/doc/gen/xml_resource.rb +0 -320
  515. data/lib/wx/grid/events/evt_list.rb +0 -166
  516. data/lib/wx/html/events/evt_list.rb +0 -27
  517. data/lib/wx/pg/events/evt_list.rb +0 -73
  518. data/lib/wx/rbn/events/evt_list.rb +0 -102
  519. data/lib/wx/rtc/events/evt_list.rb +0 -98
  520. data/lib/wx/rtc/ext/rich_text_ctrl.rb +0 -24
  521. data/lib/wx/stc/events/evt_list.rb +0 -178
  522. data/samples/art/wxruby-512x512.png +0 -0
@@ -1,2922 +0,0 @@
1
- # :stopdoc:
2
- # This file is automatically generated by the WXRuby3 documentation
3
- # generator. Do not alter this file.
4
- # :startdoc:
5
-
6
-
7
- module Wx
8
-
9
- module RTC
10
-
11
- #
12
- RICHTEXT_FIXED_WIDTH = 1
13
-
14
- #
15
- RICHTEXT_FIXED_HEIGHT = 2
16
-
17
- #
18
- RICHTEXT_VARIABLE_WIDTH = 4
19
-
20
- #
21
- RICHTEXT_VARIABLE_HEIGHT = 8
22
-
23
- #
24
- RICHTEXT_LAYOUT_SPECIFIED_RECT = 16
25
-
26
- #
27
- RICHTEXT_DRAW_IGNORE_CACHE = 1
28
-
29
- #
30
- RICHTEXT_DRAW_SELECTED = 2
31
-
32
- #
33
- RICHTEXT_DRAW_PRINT = 4
34
-
35
- #
36
- RICHTEXT_DRAW_GUIDELINES = 8
37
-
38
- #
39
- RICHTEXT_FORMATTED = 1
40
-
41
- #
42
- RICHTEXT_UNFORMATTED = 2
43
-
44
- #
45
- RICHTEXT_CACHE_SIZE = 4
46
-
47
- #
48
- RICHTEXT_HEIGHT_ONLY = 8
49
-
50
- #
51
- RICHTEXT_SETSTYLE_NONE = 0
52
-
53
- #
54
- RICHTEXT_SETSTYLE_WITH_UNDO = 1
55
-
56
- #
57
- RICHTEXT_SETSTYLE_OPTIMIZE = 2
58
-
59
- #
60
- RICHTEXT_SETSTYLE_PARAGRAPHS_ONLY = 4
61
-
62
- #
63
- RICHTEXT_SETSTYLE_CHARACTERS_ONLY = 8
64
-
65
- #
66
- RICHTEXT_SETSTYLE_RENUMBER = 16
67
-
68
- #
69
- RICHTEXT_SETSTYLE_SPECIFY_LEVEL = 32
70
-
71
- #
72
- RICHTEXT_SETSTYLE_RESET = 64
73
-
74
- #
75
- RICHTEXT_SETSTYLE_REMOVE = 128
76
-
77
- #
78
- RICHTEXT_SETPROPERTIES_NONE = 0
79
-
80
- #
81
- RICHTEXT_SETPROPERTIES_WITH_UNDO = 1
82
-
83
- #
84
- RICHTEXT_SETPROPERTIES_PARAGRAPHS_ONLY = 2
85
-
86
- #
87
- RICHTEXT_SETPROPERTIES_CHARACTERS_ONLY = 4
88
-
89
- #
90
- RICHTEXT_SETPROPERTIES_RESET = 8
91
-
92
- #
93
- RICHTEXT_SETPROPERTIES_REMOVE = 16
94
-
95
- #
96
- RICHTEXT_INSERT_NONE = 0
97
-
98
- #
99
- RICHTEXT_INSERT_WITH_PREVIOUS_PARAGRAPH_STYLE = 1
100
-
101
- #
102
- RICHTEXT_INSERT_INTERACTIVE = 2
103
-
104
- #
105
- TEXT_ATTR_KEEP_FIRST_PARA_STYLE = 268435456
106
-
107
- #
108
- SCRIPT_MUL_FACTOR = 1.5
109
-
110
- #
111
- RICHTEXT_HANDLER_INCLUDE_STYLESHEET = 1
112
-
113
- #
114
- RICHTEXT_HANDLER_SAVE_IMAGES_TO_MEMORY = 16
115
-
116
- #
117
- RICHTEXT_HANDLER_SAVE_IMAGES_TO_FILES = 32
118
-
119
- #
120
- RICHTEXT_HANDLER_SAVE_IMAGES_TO_BASE64 = 64
121
-
122
- #
123
- RICHTEXT_HANDLER_NO_HEADER_FOOTER = 128
124
-
125
- #
126
- RICHTEXT_HANDLER_CONVERT_FACENAMES = 256
127
-
128
- #
129
- RICHTEXT_HANDLER_USE_CSS = 4096
130
-
131
- # File types in {Wx::RichText} context.
132
- #
133
- #
134
- #
135
- # @wxrb_require USE_RICHTEXT
136
- class RichTextFileType < Wx::Enum
137
-
138
- #
139
- #
140
- RICHTEXT_TYPE_ANY = Wx::RTC::RichTextFileType.new(0)
141
-
142
- #
143
- #
144
- RICHTEXT_TYPE_TEXT = Wx::RTC::RichTextFileType.new(1)
145
-
146
- #
147
- #
148
- RICHTEXT_TYPE_XML = Wx::RTC::RichTextFileType.new(2)
149
-
150
- #
151
- #
152
- RICHTEXT_TYPE_HTML = Wx::RTC::RichTextFileType.new(3)
153
-
154
- #
155
- #
156
- RICHTEXT_TYPE_RTF = Wx::RTC::RichTextFileType.new(4)
157
-
158
- #
159
- #
160
- RICHTEXT_TYPE_PDF = Wx::RTC::RichTextFileType.new(5)
161
-
162
- end # RichTextFileType
163
-
164
- # Flags returned from hit-testing, or passed to hit-test function.
165
- #
166
- #
167
- #
168
- # @wxrb_require USE_RICHTEXT
169
- class RichTextHitTestFlags < Wx::Enum
170
-
171
- #
172
- #
173
- RICHTEXT_HITTEST_NONE = Wx::RTC::RichTextHitTestFlags.new(1)
174
-
175
- #
176
- #
177
- RICHTEXT_HITTEST_BEFORE = Wx::RTC::RichTextHitTestFlags.new(2)
178
-
179
- #
180
- #
181
- RICHTEXT_HITTEST_AFTER = Wx::RTC::RichTextHitTestFlags.new(4)
182
-
183
- #
184
- #
185
- RICHTEXT_HITTEST_ON = Wx::RTC::RichTextHitTestFlags.new(8)
186
-
187
- #
188
- #
189
- RICHTEXT_HITTEST_OUTSIDE = Wx::RTC::RichTextHitTestFlags.new(16)
190
-
191
- #
192
- #
193
- RICHTEXT_HITTEST_NO_NESTED_OBJECTS = Wx::RTC::RichTextHitTestFlags.new(32)
194
-
195
- #
196
- #
197
- RICHTEXT_HITTEST_NO_FLOATING_OBJECTS = Wx::RTC::RichTextHitTestFlags.new(64)
198
-
199
- #
200
- #
201
- RICHTEXT_HITTEST_HONOUR_ATOMIC = Wx::RTC::RichTextHitTestFlags.new(128)
202
-
203
- end # RichTextHitTestFlags
204
-
205
- # Miscellaneous text box flags.
206
- #
207
- #
208
- #
209
- # @wxrb_require USE_RICHTEXT
210
- class TextBoxAttrFlags < Wx::Enum
211
-
212
- #
213
- #
214
- TEXT_BOX_ATTR_FLOAT = Wx::RTC::TextBoxAttrFlags.new(1)
215
-
216
- #
217
- #
218
- TEXT_BOX_ATTR_CLEAR = Wx::RTC::TextBoxAttrFlags.new(2)
219
-
220
- #
221
- #
222
- TEXT_BOX_ATTR_COLLAPSE_BORDERS = Wx::RTC::TextBoxAttrFlags.new(4)
223
-
224
- #
225
- #
226
- TEXT_BOX_ATTR_VERTICAL_ALIGNMENT = Wx::RTC::TextBoxAttrFlags.new(8)
227
-
228
- #
229
- #
230
- TEXT_BOX_ATTR_BOX_STYLE_NAME = Wx::RTC::TextBoxAttrFlags.new(16)
231
-
232
- #
233
- #
234
- TEXT_BOX_ATTR_WHITESPACE = Wx::RTC::TextBoxAttrFlags.new(32)
235
-
236
- #
237
- #
238
- TEXT_BOX_ATTR_CORNER_RADIUS = Wx::RTC::TextBoxAttrFlags.new(64)
239
-
240
- end # TextBoxAttrFlags
241
-
242
- # Whether a value is present, used in dimension flags.
243
- #
244
- #
245
- #
246
- # @wxrb_require USE_RICHTEXT
247
- class TextAttrValueFlags < Wx::Enum
248
-
249
- #
250
- #
251
- TEXT_ATTR_VALUE_VALID = Wx::RTC::TextAttrValueFlags.new(4096)
252
-
253
- #
254
- #
255
- TEXT_ATTR_VALUE_VALID_MASK = Wx::RTC::TextAttrValueFlags.new(4096)
256
-
257
- end # TextAttrValueFlags
258
-
259
- # Units, included in the dimension value.
260
- #
261
- #
262
- #
263
- # @wxrb_require USE_RICHTEXT
264
- class TextAttrUnits < Wx::Enum
265
-
266
- #
267
- #
268
- TEXT_ATTR_UNITS_TENTHS_MM = Wx::RTC::TextAttrUnits.new(1)
269
-
270
- #
271
- #
272
- TEXT_ATTR_UNITS_PIXELS = Wx::RTC::TextAttrUnits.new(2)
273
-
274
- #
275
- #
276
- TEXT_ATTR_UNITS_PERCENTAGE = Wx::RTC::TextAttrUnits.new(4)
277
-
278
- #
279
- #
280
- TEXT_ATTR_UNITS_POINTS = Wx::RTC::TextAttrUnits.new(8)
281
-
282
- #
283
- #
284
- TEXT_ATTR_UNITS_HUNDREDTHS_POINT = Wx::RTC::TextAttrUnits.new(256)
285
-
286
- #
287
- #
288
- TEXT_ATTR_UNITS_MASK = Wx::RTC::TextAttrUnits.new(271)
289
-
290
- end # TextAttrUnits
291
-
292
- # Position alternatives, included in the dimension flags.
293
- #
294
- #
295
- #
296
- # @wxrb_require USE_RICHTEXT
297
- class TextBoxAttrPosition < Wx::Enum
298
-
299
- #
300
- #
301
- TEXT_BOX_ATTR_POSITION_STATIC = Wx::RTC::TextBoxAttrPosition.new(0)
302
-
303
- #
304
- #
305
- TEXT_BOX_ATTR_POSITION_RELATIVE = Wx::RTC::TextBoxAttrPosition.new(16)
306
-
307
- #
308
- #
309
- TEXT_BOX_ATTR_POSITION_ABSOLUTE = Wx::RTC::TextBoxAttrPosition.new(32)
310
-
311
- #
312
- #
313
- TEXT_BOX_ATTR_POSITION_FIXED = Wx::RTC::TextBoxAttrPosition.new(64)
314
-
315
- #
316
- #
317
- TEXT_BOX_ATTR_POSITION_MASK = Wx::RTC::TextBoxAttrPosition.new(240)
318
-
319
- end # TextBoxAttrPosition
320
-
321
- # Border styles, used with {Wx::RTC::TextAttrBorder}.
322
- #
323
- #
324
- #
325
- # @wxrb_require USE_RICHTEXT
326
- class TextAttrBorderStyle < Wx::Enum
327
-
328
- #
329
- #
330
- TEXT_BOX_ATTR_BORDER_NONE = Wx::RTC::TextAttrBorderStyle.new(0)
331
-
332
- #
333
- #
334
- TEXT_BOX_ATTR_BORDER_SOLID = Wx::RTC::TextAttrBorderStyle.new(1)
335
-
336
- #
337
- #
338
- TEXT_BOX_ATTR_BORDER_DOTTED = Wx::RTC::TextAttrBorderStyle.new(2)
339
-
340
- #
341
- #
342
- TEXT_BOX_ATTR_BORDER_DASHED = Wx::RTC::TextAttrBorderStyle.new(3)
343
-
344
- #
345
- #
346
- TEXT_BOX_ATTR_BORDER_DOUBLE = Wx::RTC::TextAttrBorderStyle.new(4)
347
-
348
- #
349
- #
350
- TEXT_BOX_ATTR_BORDER_GROOVE = Wx::RTC::TextAttrBorderStyle.new(5)
351
-
352
- #
353
- #
354
- TEXT_BOX_ATTR_BORDER_RIDGE = Wx::RTC::TextAttrBorderStyle.new(6)
355
-
356
- #
357
- #
358
- TEXT_BOX_ATTR_BORDER_INSET = Wx::RTC::TextAttrBorderStyle.new(7)
359
-
360
- #
361
- #
362
- TEXT_BOX_ATTR_BORDER_OUTSET = Wx::RTC::TextAttrBorderStyle.new(8)
363
-
364
- end # TextAttrBorderStyle
365
-
366
- # Border style presence flags, used with {Wx::RTC::TextAttrBorder}.
367
- #
368
- #
369
- #
370
- # @wxrb_require USE_RICHTEXT
371
- class TextAttrBorderFlags < Wx::Enum
372
-
373
- #
374
- #
375
- TEXT_BOX_ATTR_BORDER_STYLE = Wx::RTC::TextAttrBorderFlags.new(1)
376
-
377
- #
378
- #
379
- TEXT_BOX_ATTR_BORDER_COLOUR = Wx::RTC::TextAttrBorderFlags.new(2)
380
-
381
- end # TextAttrBorderFlags
382
-
383
- # Border width symbols for qualitative widths, used with {Wx::RTC::TextAttrBorder}.
384
- #
385
- #
386
- #
387
- # @wxrb_require USE_RICHTEXT
388
- class TextAttrBorderWidth < Wx::Enum
389
-
390
- #
391
- #
392
- TEXT_BOX_ATTR_BORDER_THIN = Wx::RTC::TextAttrBorderWidth.new(-1)
393
-
394
- #
395
- #
396
- TEXT_BOX_ATTR_BORDER_MEDIUM = Wx::RTC::TextAttrBorderWidth.new(-2)
397
-
398
- #
399
- #
400
- TEXT_BOX_ATTR_BORDER_THICK = Wx::RTC::TextAttrBorderWidth.new(-3)
401
-
402
- end # TextAttrBorderWidth
403
-
404
- # Float styles.
405
- #
406
- #
407
- #
408
- # @wxrb_require USE_RICHTEXT
409
- class TextBoxAttrFloatStyle < Wx::Enum
410
-
411
- #
412
- #
413
- TEXT_BOX_ATTR_FLOAT_NONE = Wx::RTC::TextBoxAttrFloatStyle.new(0)
414
-
415
- #
416
- #
417
- TEXT_BOX_ATTR_FLOAT_LEFT = Wx::RTC::TextBoxAttrFloatStyle.new(1)
418
-
419
- #
420
- #
421
- TEXT_BOX_ATTR_FLOAT_RIGHT = Wx::RTC::TextBoxAttrFloatStyle.new(2)
422
-
423
- end # TextBoxAttrFloatStyle
424
-
425
- # Clear styles.
426
- #
427
- #
428
- #
429
- # @wxrb_require USE_RICHTEXT
430
- class TextBoxAttrClearStyle < Wx::Enum
431
-
432
- #
433
- #
434
- TEXT_BOX_ATTR_CLEAR_NONE = Wx::RTC::TextBoxAttrClearStyle.new(0)
435
-
436
- #
437
- #
438
- TEXT_BOX_ATTR_CLEAR_LEFT = Wx::RTC::TextBoxAttrClearStyle.new(1)
439
-
440
- #
441
- #
442
- TEXT_BOX_ATTR_CLEAR_RIGHT = Wx::RTC::TextBoxAttrClearStyle.new(2)
443
-
444
- #
445
- #
446
- TEXT_BOX_ATTR_CLEAR_BOTH = Wx::RTC::TextBoxAttrClearStyle.new(3)
447
-
448
- end # TextBoxAttrClearStyle
449
-
450
- # Collapse mode styles.
451
- #
452
- #
453
- #
454
- # @wxrb_require USE_RICHTEXT
455
- class TextBoxAttrCollapseMode < Wx::Enum
456
-
457
- #
458
- #
459
- TEXT_BOX_ATTR_COLLAPSE_NONE = Wx::RTC::TextBoxAttrCollapseMode.new(0)
460
-
461
- #
462
- #
463
- TEXT_BOX_ATTR_COLLAPSE_FULL = Wx::RTC::TextBoxAttrCollapseMode.new(1)
464
-
465
- end # TextBoxAttrCollapseMode
466
-
467
- # Vertical alignment values.
468
- #
469
- #
470
- #
471
- # @wxrb_require USE_RICHTEXT
472
- class TextBoxAttrVerticalAlignment < Wx::Enum
473
-
474
- #
475
- #
476
- TEXT_BOX_ATTR_VERTICAL_ALIGNMENT_NONE = Wx::RTC::TextBoxAttrVerticalAlignment.new(0)
477
-
478
- #
479
- #
480
- TEXT_BOX_ATTR_VERTICAL_ALIGNMENT_TOP = Wx::RTC::TextBoxAttrVerticalAlignment.new(1)
481
-
482
- #
483
- #
484
- TEXT_BOX_ATTR_VERTICAL_ALIGNMENT_CENTRE = Wx::RTC::TextBoxAttrVerticalAlignment.new(2)
485
-
486
- #
487
- #
488
- TEXT_BOX_ATTR_VERTICAL_ALIGNMENT_BOTTOM = Wx::RTC::TextBoxAttrVerticalAlignment.new(3)
489
-
490
- end # TextBoxAttrVerticalAlignment
491
-
492
- # Whitespace values mirroring the CSS white-space attribute.
493
- #
494
- # Only {Wx::RTC::TextBoxAttrWhitespaceMode::TEXT_BOX_ATTR_WHITESPACE_NO_WRAP} is currently implemented, in table cells.
495
- #
496
- # @wxrb_require USE_RICHTEXT
497
- class TextBoxAttrWhitespaceMode < Wx::Enum
498
-
499
- #
500
- #
501
- TEXT_BOX_ATTR_WHITESPACE_NONE = Wx::RTC::TextBoxAttrWhitespaceMode.new(0)
502
-
503
- #
504
- #
505
- TEXT_BOX_ATTR_WHITESPACE_NORMAL = Wx::RTC::TextBoxAttrWhitespaceMode.new(1)
506
-
507
- #
508
- #
509
- TEXT_BOX_ATTR_WHITESPACE_NO_WRAP = Wx::RTC::TextBoxAttrWhitespaceMode.new(2)
510
-
511
- #
512
- #
513
- TEXT_BOX_ATTR_WHITESPACE_PREFORMATTED = Wx::RTC::TextBoxAttrWhitespaceMode.new(3)
514
-
515
- #
516
- #
517
- TEXT_BOX_ATTR_WHITESPACE_PREFORMATTED_LINE = Wx::RTC::TextBoxAttrWhitespaceMode.new(4)
518
-
519
- #
520
- #
521
- TEXT_BOX_ATTR_WHITESPACE_PREFORMATTED_WRAP = Wx::RTC::TextBoxAttrWhitespaceMode.new(5)
522
-
523
- end # TextBoxAttrWhitespaceMode
524
-
525
- # The command identifiers for Do/Undo.
526
- #
527
- #
528
- #
529
- # @wxrb_require USE_RICHTEXT
530
- class RichTextCommandId < Wx::Enum
531
-
532
- #
533
- #
534
- RICHTEXT_INSERT = Wx::RTC::RichTextCommandId.new(0)
535
-
536
- #
537
- #
538
- RICHTEXT_DELETE = Wx::RTC::RichTextCommandId.new(1)
539
-
540
- #
541
- #
542
- RICHTEXT_CHANGE_ATTRIBUTES = Wx::RTC::RichTextCommandId.new(2)
543
-
544
- #
545
- #
546
- RICHTEXT_CHANGE_STYLE = Wx::RTC::RichTextCommandId.new(3)
547
-
548
- #
549
- #
550
- RICHTEXT_CHANGE_OBJECT = Wx::RTC::RichTextCommandId.new(5)
551
-
552
- end # RichTextCommandId
553
-
554
- # The line break character that can be embedded in content.
555
- #
556
- RICH_TEXT_LINE_BREAK_CHAR = "\u001D"
557
-
558
- # This is the base for drawable rich text objects.
559
- #
560
- # Category: Rich Text
561
- # @see Wx::RTC::RichTextBuffer
562
- # @see Wx::RTC::RichTextCtrl
563
- #
564
- #
565
- #
566
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
567
- # @wxrb_require USE_RICHTEXT
568
- class RichTextObject < Object
569
-
570
- # Constructor, taking an optional parent pointer.
571
- # @param parent [Wx::RTC::RichTextObject]
572
- # @return [Wx::RTC::RichTextObject]
573
- def initialize(parent=nil) end
574
-
575
- # Draw the item, within the given range.
576
- #
577
- # Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)
578
- # @param dc [Wx::DC]
579
- # @param context [Wx::RTC::RichTextDrawingContext]
580
- # @param range [Range]
581
- # @param selection [Wx::RTC::RichTextSelection]
582
- # @param rect [Wx::Rect]
583
- # @param descent [Integer]
584
- # @param style [Integer]
585
- # @return [Boolean]
586
- def draw(dc, context, range, selection, rect, descent, style) end
587
-
588
- # Lay the item out at the specified position with the given size constraint.
589
- #
590
- # 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).
591
- # @param dc [Wx::ReadOnlyDC]
592
- # @param context [Wx::RTC::RichTextDrawingContext]
593
- # @param rect [Wx::Rect]
594
- # @param parentRect [Wx::Rect]
595
- # @param style [Integer]
596
- # @return [Boolean]
597
- def layout(dc, context, rect, parentRect, style) end
598
-
599
- # Hit-testing: returns a flag indicating hit test details, plus information about position.
600
- #
601
- # 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.
602
- # 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).
603
- # One of the {Wx::RTC::RichTextHitTestFlags} values.
604
- # @param dc [Wx::ReadOnlyDC]
605
- # @param context [Wx::RTC::RichTextDrawingContext]
606
- # @param pt [Array(Integer, Integer), Wx::Point]
607
- # @param textPosition [Integer]
608
- # @param flags [Integer]
609
- # @return [Array(Integer,Integer,Wx::RTC::RichTextObject,Wx::RTC::RichTextObject)]
610
- def hit_test(dc, context, pt, textPosition, flags=0) end
611
-
612
- # Finds the absolute position and row height for the given character position.
613
- # @param dc [Wx::ReadOnlyDC]
614
- # @param context [Wx::RTC::RichTextDrawingContext]
615
- # @param index [Integer]
616
- # @param pt [Array(Integer, Integer), Wx::Point]
617
- # @param forceLineStart [Boolean]
618
- # @return [Array(Boolean,Integer)]
619
- def find_position(dc, context, index, pt, forceLineStart) end
620
-
621
- # Returns the best size, i.e. the ideal starting size for this object irrespective of available space.
622
- #
623
- # For a short text string, it will be the size that exactly encloses the text. For a longer string, it might use the parent width for example.
624
- # @return [Wx::Size]
625
- def get_best_size; end
626
- alias_method :best_size, :get_best_size
627
-
628
- # Returns the object size for the given range.
629
- #
630
- # Returns false if the range is invalid for this object.
631
- # @param range [Range]
632
- # @param size [Array(Integer, Integer), Wx::Size]
633
- # @param descent [Integer]
634
- # @param dc [Wx::ReadOnlyDC]
635
- # @param context [Wx::RTC::RichTextDrawingContext]
636
- # @param flags [Integer]
637
- # @param position [Array(Integer, Integer), Wx::Point]
638
- # @param parentSize [Array(Integer, Integer), Wx::Size]
639
- # @param partialExtents [Array,nil]
640
- # @return [Array(Boolean,Integer)]
641
- def get_range_size(range, size, descent, dc, context, flags, position=(Wx::Point.new(0, 0)), parentSize=Wx::DEFAULT_SIZE, partialExtents=nil) end
642
- alias_method :range_size, :get_range_size
643
-
644
- # Do a split from pos, returning an object containing the second part, and setting the first part in 'this'.
645
- # @param pos [Integer]
646
- # @return [Wx::RTC::RichTextObject]
647
- def do_split(pos) end
648
-
649
- # Calculates the range of the object.
650
- #
651
- # By default, guess that the object is 1 unit long.
652
- # @param start [Integer]
653
- # @param end_ [Integer]
654
- # @return [Integer]
655
- def calculate_range(start, end_) end
656
-
657
- # Deletes the given range.
658
- # @param range [Range]
659
- # @return [Boolean]
660
- def delete_range(range) end
661
-
662
- # Returns true if the object is empty.
663
- # @return [Boolean]
664
- def is_empty; end
665
- alias_method :empty?, :is_empty
666
-
667
- # Returns true if this class of object is floatable.
668
- # @return [Boolean]
669
- def is_floatable; end
670
- alias_method :floatable?, :is_floatable
671
-
672
- # Returns true if this object is currently floating.
673
- # @return [Boolean]
674
- def is_floating; end
675
- alias_method :floating?, :is_floating
676
-
677
- # Returns the floating direction.
678
- # @return [Integer]
679
- def get_float_direction; end
680
- alias_method :float_direction, :get_float_direction
681
-
682
- # Returns any text in this object for the given range.
683
- # @param range [Range]
684
- # @return [String]
685
- def get_text_for_range(range) end
686
- alias_method :text_for_range, :get_text_for_range
687
-
688
- # Returns true if this object can merge itself with the given one.
689
- # @param object [Wx::RTC::RichTextObject]
690
- # @param context [Wx::RTC::RichTextDrawingContext]
691
- # @return [Boolean]
692
- def can_merge(object, context) end
693
- alias_method :can_merge?, :can_merge
694
-
695
- # Returns true if this object merged itself with the given one.
696
- #
697
- # The calling code will then delete the given object.
698
- # @param object [Wx::RTC::RichTextObject]
699
- # @param context [Wx::RTC::RichTextDrawingContext]
700
- # @return [Boolean]
701
- def merge(object, context) end
702
-
703
- # Returns true if this object can potentially be split, by virtue of having different virtual attributes for individual sub-objects.
704
- # @param context [Wx::RTC::RichTextDrawingContext]
705
- # @return [Boolean]
706
- def can_split(context) end
707
- alias_method :can_split?, :can_split
708
-
709
- # Returns the final object in the split objects if this object was split due to differences between sub-object virtual attributes.
710
- #
711
- # Returns itself if it was not split.
712
- # @param context [Wx::RTC::RichTextDrawingContext]
713
- # @return [Wx::RTC::RichTextObject]
714
- def split(context) end
715
-
716
- # Dump object data to the given output stream for debugging.
717
- # @param stream [IO,Wx::OutputStream]
718
- # @return [void]
719
- def dump(stream) end
720
-
721
- # Returns true if we can edit the object's properties via a GUI.
722
- # @return [Boolean]
723
- def can_edit_properties; end
724
- alias_method :can_edit_properties?, :can_edit_properties
725
-
726
- # Edits the object's properties via a GUI.
727
- # @param parent [Wx::Window]
728
- # @param buffer [Wx::RTC::RichTextBuffer]
729
- # @return [Boolean]
730
- def edit_properties(parent, buffer) end
731
-
732
- # Returns the label to be used for the properties context menu item.
733
- # @return [String]
734
- def get_properties_menu_label; end
735
- alias_method :properties_menu_label, :get_properties_menu_label
736
-
737
- # Returns true if objects of this class can accept the focus, i.e. a call to SetFocusObject is possible.
738
- #
739
- # 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).
740
- # @return [Boolean]
741
- def accepts_focus; end
742
-
743
- # Imports this object from XML.
744
- # @param buffer [Wx::RTC::RichTextBuffer]
745
- # @param node [Wx::XmlNode]
746
- # @param handler [Wx::RTC::RichTextXMLHandler]
747
- # @param recurse [Boolean]
748
- # @return [Array(Boolean,Boolean)]
749
- def import_from_xml(buffer, node, handler, recurse) end
750
-
751
- # Returns true if this object takes note of paragraph attributes (text and image objects don't).
752
- # @return [Boolean]
753
- def uses_paragraph_attributes; end
754
-
755
- # Returns the XML node name of this object.
756
- #
757
- # This must be overridden for {Wx::XmlNode}-base XML export to work.
758
- # @return [String]
759
- def get_xml_node_name; end
760
- alias_method :xml_node_name, :get_xml_node_name
761
-
762
- # Invalidates the object at the given range.
763
- #
764
- # With no argument, invalidates the whole object.
765
- # @param invalidRange [Range]
766
- # @return [void]
767
- def invalidate(invalidRange=Wx::RICHTEXT_ALL) end
768
-
769
- # Returns true if this object can handle the selections of its children, fOr example a table.
770
- #
771
- # Required for composite selection handling to work.
772
- # @return [Boolean]
773
- def handles_child_selections; end
774
-
775
- # Returns a selection object specifying the selections between start and end character positions.
776
- #
777
- # For example, a table would deduce what cells (of range length 1) are selected when dragging across the table.
778
- # @param start [Integer]
779
- # @param end_ [Integer]
780
- # @return [Wx::RTC::RichTextSelection]
781
- def get_selection(start, end_) end
782
- alias_method :selection, :get_selection
783
-
784
- # Gets the cached object size as calculated by Layout.
785
- # @return [Wx::Size]
786
- def get_cached_size; end
787
- alias_method :cached_size, :get_cached_size
788
-
789
- # Sets the cached object size as calculated by Layout.
790
- # @param sz [Array(Integer, Integer), Wx::Size]
791
- # @return [void]
792
- def set_cached_size(sz) end
793
- alias_method :cached_size=, :set_cached_size
794
-
795
- # Gets the maximum object size as calculated by Layout.
796
- #
797
- # This allows us to fit an object to its contents or allocate extra space if required.
798
- # @return [Wx::Size]
799
- def get_max_size; end
800
- alias_method :max_size, :get_max_size
801
-
802
- # Sets the maximum object size as calculated by Layout.
803
- #
804
- # This allows us to fit an object to its contents or allocate extra space if required.
805
- # @param sz [Array(Integer, Integer), Wx::Size]
806
- # @return [void]
807
- def set_max_size(sz) end
808
- alias_method :max_size=, :set_max_size
809
-
810
- # Gets the minimum object size as calculated by Layout.
811
- #
812
- # This allows us to constrain an object to its absolute minimum size if necessary.
813
- # @return [Wx::Size]
814
- def get_min_size; end
815
- alias_method :min_size, :get_min_size
816
-
817
- # Sets the minimum object size as calculated by Layout.
818
- #
819
- # This allows us to constrain an object to its absolute minimum size if necessary.
820
- # @param sz [Array(Integer, Integer), Wx::Size]
821
- # @return [void]
822
- def set_min_size(sz) end
823
- alias_method :min_size=, :set_min_size
824
-
825
- # Gets the 'natural' size for an object.
826
- #
827
- # For an image, it would be the image size.
828
- # @return [Wx::RTC::TextAttrSize]
829
- def get_natural_size; end
830
- alias_method :natural_size, :get_natural_size
831
-
832
- # Returns the object position in pixels.
833
- # @return [Wx::Point]
834
- def get_position; end
835
- alias_method :position, :get_position
836
-
837
- # Sets the object position in pixels.
838
- # @param pos [Array(Integer, Integer), Wx::Point]
839
- # @return [void]
840
- def set_position(pos) end
841
- alias_method :position=, :set_position
842
-
843
- # Returns the absolute object position, by traversing up the child/parent hierarchy.
844
- #
845
- # TODO: may not be needed, if all object positions are in fact relative to the top of the coordinate space.
846
- # @return [Wx::Point]
847
- def get_absolute_position; end
848
- alias_method :absolute_position, :get_absolute_position
849
-
850
- # Returns the rectangle enclosing the object.
851
- # @return [Wx::Rect]
852
- def get_rect; end
853
- alias_method :rect, :get_rect
854
-
855
- # Sets the object's range within its container.
856
- # @param range [Range]
857
- # @return [void]
858
- def set_range(range) end
859
- alias_method :range=, :set_range
860
-
861
- # Returns the object's range.
862
- # @return [Range]
863
- def get_range; end
864
- alias_method :range, :get_range
865
-
866
- # Set the object's own range, for a top-level object with its own position space.
867
- # @param range [Range]
868
- # @return [void]
869
- def set_own_range(range) end
870
- alias_method :own_range=, :set_own_range
871
-
872
- # Returns the object's own range (valid if top-level).
873
- # @return [Range]
874
- def get_own_range; end
875
- alias_method :own_range, :get_own_range
876
-
877
- # Returns the object's own range only if a top-level object.
878
- # @return [Range]
879
- def get_own_range_if_top_level; end
880
- alias_method :own_range_if_top_level, :get_own_range_if_top_level
881
-
882
- # Returns true if this object is composite.
883
- # @return [Boolean]
884
- def is_composite; end
885
- alias_method :composite?, :is_composite
886
-
887
- # Returns true if no user editing can be done inside the object.
888
- #
889
- # This returns true for simple objects, false for most composite objects, but true for fields, which if composite, should not be user-edited.
890
- # @return [Boolean]
891
- def is_atomic; end
892
- alias_method :atomic?, :is_atomic
893
-
894
- # Returns a pointer to the parent object.
895
- # @return [Wx::RTC::RichTextObject]
896
- def get_parent; end
897
- alias_method :parent, :get_parent
898
-
899
- # Sets the pointer to the parent object.
900
- # @param parent [Wx::RTC::RichTextObject]
901
- # @return [void]
902
- def set_parent(parent) end
903
- alias_method :parent=, :set_parent
904
-
905
- # Returns the top-level container of this object.
906
- #
907
- # May return itself if it's a container; use GetParentContainer to return a different container.
908
- # @return [Wx::RTC::RichTextParagraphLayoutBox]
909
- def get_container; end
910
- alias_method :container, :get_container
911
-
912
- # Returns the top-level container of this object.
913
- #
914
- # Returns a different container than itself, unless there's no parent, in which case it will return nil.
915
- # @return [Wx::RTC::RichTextParagraphLayoutBox]
916
- def get_parent_container; end
917
- alias_method :parent_container, :get_parent_container
918
-
919
- # @overload set_margins(margin)
920
- # Set the margin around the object, in pixels.
921
- # @param margin [Integer]
922
- # @return [void]
923
- # @overload set_margins(leftMargin, rightMargin, topMargin, bottomMargin)
924
- # Set the margin around the object, in pixels.
925
- # @param leftMargin [Integer]
926
- # @param rightMargin [Integer]
927
- # @param topMargin [Integer]
928
- # @param bottomMargin [Integer]
929
- # @return [void]
930
- def set_margins(*args) end
931
- alias_method :margins=, :set_margins
932
-
933
- # Returns the left margin of the object, in pixels.
934
- # @return [Integer]
935
- def get_left_margin; end
936
- alias_method :left_margin, :get_left_margin
937
-
938
- # Returns the right margin of the object, in pixels.
939
- # @return [Integer]
940
- def get_right_margin; end
941
- alias_method :right_margin, :get_right_margin
942
-
943
- # Returns the top margin of the object, in pixels.
944
- # @return [Integer]
945
- def get_top_margin; end
946
- alias_method :top_margin, :get_top_margin
947
-
948
- # Returns the bottom margin of the object, in pixels.
949
- # @return [Integer]
950
- def get_bottom_margin; end
951
- alias_method :bottom_margin, :get_bottom_margin
952
-
953
- # Calculates the available content space in the given rectangle, given the margins, border and padding specified in the object's attributes.
954
- # @param dc [Wx::ReadOnlyDC]
955
- # @param context [Wx::RTC::RichTextDrawingContext]
956
- # @param outerRect [Wx::Rect]
957
- # @return [Wx::Rect]
958
- def get_available_content_area(dc, context, outerRect) end
959
- alias_method :available_content_area, :get_available_content_area
960
-
961
- # Lays out the object first with a given amount of space, and then if no width was specified in attr, lays out the object again using the minimum size.
962
- #
963
- # availableParentSpace is the maximum space for the object, whereas availableContainerSpace is the container with which relative positions and sizes should be computed. For example, a text box whose space has already been constrained in a previous layout pass to availableParentSpace, but should have a width of 50% of availableContainerSpace. (If these two rects were the same, a 2nd pass could see the object getting too small.)
964
- # @param dc [Wx::ReadOnlyDC]
965
- # @param context [Wx::RTC::RichTextDrawingContext]
966
- # @param buffer [Wx::RTC::RichTextBuffer]
967
- # @param parentAttr [Wx::RTC::RichTextAttr]
968
- # @param attr [Wx::RTC::RichTextAttr]
969
- # @param availableParentSpace [Wx::Rect]
970
- # @param availableContainerSpace [Wx::Rect]
971
- # @param style [Integer]
972
- # @return [Boolean]
973
- def layout_to_best_size(dc, context, buffer, parentAttr, attr, availableParentSpace, availableContainerSpace, style) end
974
-
975
- # Adjusts the attributes for virtual attribute provision, collapsed borders, etc.
976
- # @param attr [Wx::RTC::RichTextAttr]
977
- # @param context [Wx::RTC::RichTextDrawingContext]
978
- # @return [Boolean]
979
- def adjust_attributes(attr, context) end
980
-
981
- # Sets the object's attributes.
982
- # @param attr [Wx::RTC::RichTextAttr]
983
- # @return [void]
984
- def set_attributes(attr) end
985
- alias_method :attributes=, :set_attributes
986
-
987
- # Returns the object's attributes.
988
- # @return [Wx::RTC::RichTextAttr]
989
- def get_attributes; end
990
- alias_method :attributes, :get_attributes
991
-
992
- # Returns the object's properties.
993
- # @return [Wx::RTC::RichTextProperties]
994
- def get_properties; end
995
- alias_method :properties, :get_properties
996
-
997
- # Sets the object's properties.
998
- # @param props [Wx::RTC::RichTextProperties]
999
- # @return [void]
1000
- def set_properties(props) end
1001
- alias_method :properties=, :set_properties
1002
-
1003
- # Sets the stored descent value.
1004
- # @param descent [Integer]
1005
- # @return [void]
1006
- def set_descent(descent) end
1007
- alias_method :descent=, :set_descent
1008
-
1009
- # Returns the stored descent value.
1010
- # @return [Integer]
1011
- def get_descent; end
1012
- alias_method :descent, :get_descent
1013
-
1014
- # Returns the containing buffer.
1015
- # @return [Wx::RTC::RichTextBuffer]
1016
- def get_buffer; end
1017
- alias_method :buffer, :get_buffer
1018
-
1019
- # Sets the identifying name for this object as a property using the "name" key.
1020
- # @param name [String]
1021
- # @return [void]
1022
- def set_name(name) end
1023
- alias_method :name=, :set_name
1024
-
1025
- # Returns the identifying name for this object from the properties, using the "name" key.
1026
- # @return [String]
1027
- def get_name; end
1028
- alias_method :name, :get_name
1029
-
1030
- # Returns true if this object is top-level, i.e. contains its own paragraphs, such as a text box.
1031
- # @return [Boolean]
1032
- def is_top_level; end
1033
- alias_method :top_level?, :is_top_level
1034
-
1035
- # Returns true if the object will be shown, false otherwise.
1036
- # @return [Boolean]
1037
- def is_shown; end
1038
- alias_method :shown?, :is_shown
1039
-
1040
- # Call to show or hide this object.
1041
- #
1042
- # This function does not cause the content to be laid out or redrawn.
1043
- # @param show [Boolean]
1044
- # @return [void]
1045
- def show(show) end
1046
-
1047
- # Clones the object.
1048
- # @return [Wx::RTC::RichTextObject]
1049
- def clone; end
1050
-
1051
- # Copies the object.
1052
- # @param obj [Wx::RTC::RichTextObject]
1053
- # @return [void]
1054
- def copy(obj) end
1055
-
1056
- # Reference-counting allows us to use the same object in multiple lists (not yet used).
1057
- # @return [void]
1058
- def reference; end
1059
-
1060
- # Reference-counting allows us to use the same object in multiple lists (not yet used).
1061
- # @return [void]
1062
- def dereference; end
1063
-
1064
- # Moves the object recursively, by adding the offset from old to new.
1065
- # @param pt [Array(Integer, Integer), Wx::Point]
1066
- # @return [void]
1067
- def move(pt) end
1068
-
1069
- # Converts units in tenths of a millimetre to device units.
1070
- # @param dc [Wx::ReadOnlyDC]
1071
- # @param units [Integer]
1072
- # @return [Integer]
1073
- def convert_tenths_mm_to_pixels(dc, units) end
1074
-
1075
- # Converts units in tenths of a millimetre to device units.
1076
- # @param ppi [Integer]
1077
- # @param units [Integer]
1078
- # @param scale [Float]
1079
- # @return [Integer]
1080
- def self.convert_tenths_mm_to_pixels(ppi, units, scale=1.0) end
1081
-
1082
- # Convert units in pixels to tenths of a millimetre.
1083
- # @param dc [Wx::ReadOnlyDC]
1084
- # @param pixels [Integer]
1085
- # @return [Integer]
1086
- def convert_pixels_to_tenths_mm(dc, pixels) end
1087
-
1088
- # Convert units in pixels to tenths of a millimetre.
1089
- # @param ppi [Integer]
1090
- # @param pixels [Integer]
1091
- # @param scale [Float]
1092
- # @return [Integer]
1093
- def self.convert_pixels_to_tenths_mm(ppi, pixels, scale=1.0) end
1094
-
1095
- # Draws the borders and background for the given rectangle and attributes.
1096
- #
1097
- # boxRect is taken to be the outer margin box, not the box around the content.
1098
- # @param dc [Wx::DC]
1099
- # @param buffer [Wx::RTC::RichTextBuffer]
1100
- # @param attr [Wx::RTC::RichTextAttr]
1101
- # @param boxRect [Wx::Rect]
1102
- # @param flags [Integer]
1103
- # @param obj [Wx::RTC::RichTextObject]
1104
- # @return [Boolean]
1105
- def self.draw_box_attributes(dc, buffer, attr, boxRect, flags=0, obj=nil) end
1106
-
1107
- # Draws a border.
1108
- # @param dc [Wx::DC]
1109
- # @param buffer [Wx::RTC::RichTextBuffer]
1110
- # @param attr [Wx::RTC::RichTextAttr]
1111
- # @param borders [Wx::RTC::TextAttrBorders]
1112
- # @param rect [Wx::Rect]
1113
- # @param flags [Integer]
1114
- # @return [Boolean]
1115
- def self.draw_border(dc, buffer, attr, borders, rect, flags=0) end
1116
-
1117
- # Returns the various rectangles of the box model in pixels.
1118
- #
1119
- # You can either specify contentRect (inner) or marginRect (outer), and the other must be the default rectangle (no width or height). Note that the outline doesn't affect the position of the rectangle, it's drawn in whatever space is available.
1120
- # @param dc [Wx::ReadOnlyDC]
1121
- # @param buffer [Wx::RTC::RichTextBuffer]
1122
- # @param attr [Wx::RTC::RichTextAttr]
1123
- # @param marginRect [Wx::Rect]
1124
- # @param borderRect [Wx::Rect]
1125
- # @param contentRect [Wx::Rect]
1126
- # @param paddingRect [Wx::Rect]
1127
- # @param outlineRect [Wx::Rect]
1128
- # @return [Boolean]
1129
- def self.get_box_rects(dc, buffer, attr, marginRect, borderRect, contentRect, paddingRect, outlineRect) end
1130
-
1131
- # Returns the total margin for the object in pixels, taking into account margin, padding and border size.
1132
- # @param dc [Wx::ReadOnlyDC]
1133
- # @param buffer [Wx::RTC::RichTextBuffer]
1134
- # @param attr [Wx::RTC::RichTextAttr]
1135
- # @return [Array(Boolean,Integer,Integer,Integer,Integer)]
1136
- def self.get_total_margin(dc, buffer, attr) end
1137
-
1138
- # Returns the rectangle which the child has available to it given restrictions specified in the child attribute, e.g.
1139
- #
1140
- # 50% width of the parent, 400 pixels, x position 20% of the parent, etc. availableContainerSpace might be a parent that the cell has to compute its width relative to. E.g. a cell that's 50% of its parent.
1141
- # @param dc [Wx::ReadOnlyDC]
1142
- # @param buffer [Wx::RTC::RichTextBuffer]
1143
- # @param parentAttr [Wx::RTC::RichTextAttr]
1144
- # @param childAttr [Wx::RTC::RichTextAttr]
1145
- # @param availableParentSpace [Wx::Rect]
1146
- # @param availableContainerSpace [Wx::Rect]
1147
- # @return [Wx::Rect]
1148
- def self.adjust_available_space(dc, buffer, parentAttr, childAttr, availableParentSpace, availableContainerSpace) end
1149
-
1150
- end # RichTextObject
1151
-
1152
- # This object represents a single piece of text.
1153
- #
1154
- # Category: Rich Text
1155
- # @see Wx::RTC::RichTextBuffer
1156
- # @see Wx::RTC::RichTextCtrl
1157
- #
1158
- #
1159
- #
1160
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
1161
- # @wxrb_require USE_RICHTEXT
1162
- class RichTextPlainText < RichTextObject
1163
-
1164
- # @overload initialize(text=(''), parent=nil, style=nil)
1165
- # Constructor.
1166
- # @param text [String]
1167
- # @param parent [Wx::RTC::RichTextObject]
1168
- # @param style [Wx::RTC::RichTextAttr]
1169
- # @return [Wx::RTC::RichTextPlainText]
1170
- # @overload initialize(obj)
1171
- # Copy constructor.
1172
- # @param obj [Wx::RTC::RichTextPlainText]
1173
- # @return [Wx::RTC::RichTextPlainText]
1174
- def initialize(*args) end
1175
-
1176
- # Draw the item, within the given range.
1177
- #
1178
- # Some objects may ignore the range (for example paragraphs) while others must obey it (lines, to implement wrapping)
1179
- # @param dc [Wx::DC]
1180
- # @param context [Wx::RTC::RichTextDrawingContext]
1181
- # @param range [Range]
1182
- # @param selection [Wx::RTC::RichTextSelection]
1183
- # @param rect [Wx::Rect]
1184
- # @param descent [Integer]
1185
- # @param style [Integer]
1186
- # @return [Boolean]
1187
- def draw(dc, context, range, selection, rect, descent, style) end
1188
-
1189
- # Lay the item out at the specified position with the given size constraint.
1190
- #
1191
- # 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).
1192
- # @param dc [Wx::ReadOnlyDC]
1193
- # @param context [Wx::RTC::RichTextDrawingContext]
1194
- # @param rect [Wx::Rect]
1195
- # @param parentRect [Wx::Rect]
1196
- # @param style [Integer]
1197
- # @return [Boolean]
1198
- def layout(dc, context, rect, parentRect, style) end
1199
-
1200
- # Returns the object size for the given range.
1201
- #
1202
- # Returns false if the range is invalid for this object.
1203
- # @param range [Range]
1204
- # @param size [Array(Integer, Integer), Wx::Size]
1205
- # @param descent [Integer]
1206
- # @param dc [Wx::ReadOnlyDC]
1207
- # @param context [Wx::RTC::RichTextDrawingContext]
1208
- # @param flags [Integer]
1209
- # @param position [Array(Integer, Integer), Wx::Point]
1210
- # @param parentSize [Array(Integer, Integer), Wx::Size]
1211
- # @param partialExtents [Array,nil]
1212
- # @return [Array(Boolean,Integer)]
1213
- def get_range_size(range, size, descent, dc, context, flags, position=(Wx::Point.new(0, 0)), parentSize=Wx::DEFAULT_SIZE, partialExtents=nil) end
1214
- alias_method :range_size, :get_range_size
1215
-
1216
- # Returns any text in this object for the given range.
1217
- # @param range [Range]
1218
- # @return [String]
1219
- def get_text_for_range(range) end
1220
- alias_method :text_for_range, :get_text_for_range
1221
-
1222
- # Do a split from pos, returning an object containing the second part, and setting the first part in 'this'.
1223
- # @param pos [Integer]
1224
- # @return [Wx::RTC::RichTextObject]
1225
- def do_split(pos) end
1226
-
1227
- # Calculates the range of the object.
1228
- #
1229
- # By default, guess that the object is 1 unit long.
1230
- # @param start [Integer]
1231
- # @param end_ [Integer]
1232
- # @return [Integer]
1233
- def calculate_range(start, end_) end
1234
-
1235
- # Deletes the given range.
1236
- # @param range [Range]
1237
- # @return [Boolean]
1238
- def delete_range(range) end
1239
-
1240
- # Returns true if the object is empty.
1241
- # @return [Boolean]
1242
- def is_empty; end
1243
- alias_method :empty?, :is_empty
1244
-
1245
- # Returns true if this object can merge itself with the given one.
1246
- # @param object [Wx::RTC::RichTextObject]
1247
- # @param context [Wx::RTC::RichTextDrawingContext]
1248
- # @return [Boolean]
1249
- def can_merge(object, context) end
1250
- alias_method :can_merge?, :can_merge
1251
-
1252
- # Returns true if this object merged itself with the given one.
1253
- #
1254
- # The calling code will then delete the given object.
1255
- # @param object [Wx::RTC::RichTextObject]
1256
- # @param context [Wx::RTC::RichTextDrawingContext]
1257
- # @return [Boolean]
1258
- def merge(object, context) end
1259
-
1260
- # Returns true if this object can potentially be split, by virtue of having different virtual attributes for individual sub-objects.
1261
- # @param context [Wx::RTC::RichTextDrawingContext]
1262
- # @return [Boolean]
1263
- def can_split(context) end
1264
- alias_method :can_split?, :can_split
1265
-
1266
- # Returns the final object in the split objects if this object was split due to differences between sub-object virtual attributes.
1267
- #
1268
- # Returns itself if it was not split.
1269
- # @param context [Wx::RTC::RichTextDrawingContext]
1270
- # @return [Wx::RTC::RichTextObject]
1271
- def split(context) end
1272
-
1273
- # Dump object data to the given output stream for debugging.
1274
- # @param stream [IO,Wx::OutputStream]
1275
- # @return [void]
1276
- def dump(stream) end
1277
-
1278
- # Get the first position from pos that has a line break character.
1279
- # @param pos [Integer]
1280
- # @return [Integer]
1281
- def get_first_line_break_position(pos) end
1282
- alias_method :first_line_break_position, :get_first_line_break_position
1283
-
1284
- # Does this object take note of paragraph attributes? Text and image objects don't.
1285
- # @return [Boolean]
1286
- def uses_paragraph_attributes; end
1287
-
1288
- # Imports this object from XML.
1289
- # @param buffer [Wx::RTC::RichTextBuffer]
1290
- # @param node [Wx::XmlNode]
1291
- # @param handler [Wx::RTC::RichTextXMLHandler]
1292
- # @param recurse [Boolean]
1293
- # @return [Array(Boolean,Boolean)]
1294
- def import_from_xml(buffer, node, handler, recurse) end
1295
-
1296
- # Returns the XML node name of this object.
1297
- #
1298
- # This must be overridden for {Wx::XmlNode}-base XML export to work.
1299
- # @return [String]
1300
- def get_xml_node_name; end
1301
- alias_method :xml_node_name, :get_xml_node_name
1302
-
1303
- # Returns the text.
1304
- # @return [Wx::String]
1305
- def get_text; end
1306
- alias_method :text, :get_text
1307
-
1308
- # Sets the text.
1309
- # @param text [String]
1310
- # @return [void]
1311
- def set_text(text) end
1312
- alias_method :text=, :set_text
1313
-
1314
- # @param obj [Wx::RTC::RichTextPlainText]
1315
- # @return [void]
1316
- def copy(obj) end
1317
-
1318
- # Clones the object.
1319
- # @return [Wx::RTC::RichTextObject]
1320
- def clone; end
1321
-
1322
- end # RichTextPlainText
1323
-
1324
- # A class for passing information to drawing and measuring functions.
1325
- #
1326
- # Category: Rich Text
1327
- # @see Wx::RTC::RichTextBuffer
1328
- # @see Wx::RTC::RichTextCtrl
1329
- #
1330
- #
1331
- #
1332
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
1333
- # @wxrb_require USE_RICHTEXT
1334
- class RichTextDrawingContext < Object
1335
-
1336
- # Pass the buffer to the context so the context can retrieve information such as virtual attributes.
1337
- # @param buffer [Wx::RTC::RichTextBuffer]
1338
- # @return [Wx::RTC::RichTextDrawingContext]
1339
- def initialize(buffer) end
1340
-
1341
- # @return [void]
1342
- def init; end
1343
-
1344
- # Does this object have virtual attributes?
1345
- #
1346
- # Virtual attributes can be provided for visual cues without affecting the actual styling.
1347
- # @param obj [Wx::RTC::RichTextObject]
1348
- # @return [Boolean]
1349
- def has_virtual_attributes(obj) end
1350
- alias_method :has_virtual_attributes?, :has_virtual_attributes
1351
-
1352
- # Returns the virtual attributes for this object.
1353
- #
1354
- # Virtual attributes can be provided for visual cues without affecting the actual styling.
1355
- # @param obj [Wx::RTC::RichTextObject]
1356
- # @return [Wx::RTC::RichTextAttr]
1357
- def get_virtual_attributes(obj) end
1358
- alias_method :virtual_attributes, :get_virtual_attributes
1359
-
1360
- # Applies any virtual attributes relevant to this object.
1361
- # @param attr [Wx::RTC::RichTextAttr]
1362
- # @param obj [Wx::RTC::RichTextObject]
1363
- # @return [Boolean]
1364
- def apply_virtual_attributes(attr, obj) end
1365
-
1366
- # Gets the count for mixed virtual attributes for individual positions within the object.
1367
- #
1368
- # For example, individual characters within a text object may require special highlighting.
1369
- # @param obj [Wx::RTC::RichTextObject]
1370
- # @return [Integer]
1371
- def get_virtual_subobject_attributes_count(obj) end
1372
- alias_method :virtual_subobject_attributes_count, :get_virtual_subobject_attributes_count
1373
-
1374
- # Gets the mixed virtual attributes for individual positions within the object.
1375
- #
1376
- # For example, individual characters within a text object may require special highlighting. The function is passed the count returned by GetVirtualSubobjectAttributesCount.
1377
- # @param obj [Wx::RTC::RichTextObject]
1378
- # @param positions [Array<Integer>]
1379
- # @param attributes [Array]
1380
- # @return [Integer]
1381
- def get_virtual_subobject_attributes(obj, positions, attributes) end
1382
- alias_method :virtual_subobject_attributes, :get_virtual_subobject_attributes
1383
-
1384
- # Do we have virtual text for this object?
1385
- #
1386
- # Virtual text allows an application to replace characters in an object for editing and display purposes, for example for highlighting special characters.
1387
- # @param obj [Wx::RTC::RichTextPlainText]
1388
- # @return [Boolean]
1389
- def has_virtual_text(obj) end
1390
- alias_method :has_virtual_text?, :has_virtual_text
1391
-
1392
- # Gets the virtual text for this object.
1393
- # @param obj [Wx::RTC::RichTextPlainText]
1394
- # @param text [String]
1395
- # @return [Boolean]
1396
- def get_virtual_text(obj, text) end
1397
- alias_method :virtual_text, :get_virtual_text
1398
-
1399
- # Enables virtual attribute processing.
1400
- # @param b [Boolean]
1401
- # @return [void]
1402
- def enable_virtual_attributes(b) end
1403
-
1404
- # Returns true if virtual attribute processing is enabled.
1405
- # @return [Boolean]
1406
- def get_virtual_attributes_enabled; end
1407
- alias_method :virtual_attributes_enabled, :get_virtual_attributes_enabled
1408
-
1409
- # Enable or disable images.
1410
- # @param b [Boolean]
1411
- # @return [void]
1412
- def enable_images(b) end
1413
-
1414
- # Returns true if images are enabled.
1415
- # @return [Boolean]
1416
- def get_images_enabled; end
1417
- alias_method :images_enabled, :get_images_enabled
1418
-
1419
- # Set laying out flag.
1420
- # @param b [Boolean]
1421
- # @return [void]
1422
- def set_laying_out(b) end
1423
- alias_method :laying_out=, :set_laying_out
1424
-
1425
- # Returns true if laying out.
1426
- # @return [Boolean]
1427
- def get_laying_out; end
1428
- alias_method :laying_out, :get_laying_out
1429
-
1430
- # Enable or disable delayed image loading.
1431
- # @param b [Boolean]
1432
- # @return [void]
1433
- def enable_delayed_image_loading(b) end
1434
-
1435
- # Returns true if delayed image loading is enabled.
1436
- # @return [Boolean]
1437
- def get_delayed_image_loading; end
1438
- alias_method :delayed_image_loading, :get_delayed_image_loading
1439
-
1440
- end # RichTextDrawingContext
1441
-
1442
- # A class representing enhanced attributes for rich text objects.
1443
- #
1444
- # This adds a {Wx::RTC::TextBoxAttr} member to the basic {Wx::TextAttr} class.
1445
- #
1446
- # Category: Rich Text
1447
- # @see Wx::TextAttr
1448
- # @see Wx::RTC::TextBoxAttr
1449
- # @see Wx::RTC::RichTextCtrl
1450
- #
1451
- #
1452
- #
1453
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
1454
- # @wxrb_require USE_RICHTEXT
1455
- class RichTextAttr < TextAttr
1456
-
1457
- # @overload initialize(attr)
1458
- # Constructor taking a {Wx::TextAttr}.
1459
- # @param attr [Wx::TextAttr]
1460
- # @return [Wx::RTC::RichTextAttr]
1461
- # @overload initialize(attr)
1462
- # Copy constructor.
1463
- # @param attr [Wx::RTC::RichTextAttr]
1464
- # @return [Wx::RTC::RichTextAttr]
1465
- # @overload initialize()
1466
- # Default constructor.
1467
- # @return [Wx::RTC::RichTextAttr]
1468
- def initialize(*args) end
1469
-
1470
- # Copy function.
1471
- # @param attr [Wx::RTC::RichTextAttr]
1472
- # @return [void]
1473
- def copy(attr) end
1474
-
1475
- # Equality test.
1476
- # @param attr [Wx::RTC::RichTextAttr]
1477
- # @return [Boolean]
1478
- def ==(attr) end
1479
-
1480
- # Partial equality test.
1481
- #
1482
- # If weakTest is true, attributes of this object do not have to be present if those attributes of attr are present. If weakTest is false, the function will fail if an attribute is present in attr but not in this object.
1483
- # @param attr [Wx::RTC::RichTextAttr]
1484
- # @param weakTest [Boolean]
1485
- # @return [Boolean]
1486
- def eq_partial(attr, weakTest=true) end
1487
-
1488
- # Merges the given attributes.
1489
- #
1490
- # If compareWith is non-null, then it will be used to mask out those attributes that are the same in style and compareWith, for situations where we don't want to explicitly set inherited attributes.
1491
- # @param style [Wx::RTC::RichTextAttr]
1492
- # @param compareWith [Wx::RTC::RichTextAttr]
1493
- # @return [Boolean]
1494
- def apply(style, compareWith=nil) end
1495
-
1496
- # Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.
1497
- # @param attr [Wx::RTC::RichTextAttr]
1498
- # @param clashingAttr [Wx::RTC::RichTextAttr]
1499
- # @param absentAttr [Wx::RTC::RichTextAttr]
1500
- # @return [void]
1501
- def collect_common_attributes(attr, clashingAttr, absentAttr) end
1502
-
1503
- # Removes the specified attributes from this object.
1504
- # @param attr [Wx::RTC::RichTextAttr]
1505
- # @return [Boolean]
1506
- def remove_style(attr) end
1507
-
1508
- # @return [Wx::RTC::TextBoxAttr]
1509
- def get_text_box_attr; end
1510
- alias_method :text_box_attr, :get_text_box_attr
1511
-
1512
- # Set the text box attributes.
1513
- # @param attr [Wx::RTC::TextBoxAttr]
1514
- # @return [void]
1515
- def set_text_box_attr(attr) end
1516
- alias_method :text_box_attr=, :set_text_box_attr
1517
-
1518
- # Returns true if no attributes are set.
1519
- # @return [Boolean]
1520
- def is_default; end
1521
- alias_method :default?, :is_default
1522
-
1523
- end # RichTextAttr
1524
-
1525
- # A class representing the box attributes of a rich text object.
1526
- #
1527
- # Category: Rich Text
1528
- # @see Wx::RTC::RichTextAttr
1529
- # @see Wx::RTC::RichTextCtrl
1530
- #
1531
- #
1532
- #
1533
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
1534
- # @wxrb_require USE_RICHTEXT
1535
- class TextBoxAttr < ::Object
1536
-
1537
- # @overload initialize()
1538
- # Default constructor.
1539
- # @return [Wx::RTC::TextBoxAttr]
1540
- # @overload initialize(attr)
1541
- # Copy constructor.
1542
- # @param attr [Wx::RTC::TextBoxAttr]
1543
- # @return [Wx::RTC::TextBoxAttr]
1544
- def initialize(*args) end
1545
-
1546
- # Initialises this object.
1547
- # @return [void]
1548
- def init; end
1549
-
1550
- # Resets this object.
1551
- # @return [void]
1552
- def reset; end
1553
-
1554
- # Equality test.
1555
- # @param attr [Wx::RTC::TextBoxAttr]
1556
- # @return [Boolean]
1557
- def ==(attr) end
1558
-
1559
- # Partial equality test, ignoring unset attributes.
1560
- #
1561
- # If weakTest is true, attributes of this object do not have to be present if those attributes of attr are present. If weakTest is false, the function will fail if an attribute is present in attr but not in this object.
1562
- # @param attr [Wx::RTC::TextBoxAttr]
1563
- # @param weakTest [Boolean]
1564
- # @return [Boolean]
1565
- def eq_partial(attr, weakTest=true) end
1566
-
1567
- # Merges the given attributes.
1568
- #
1569
- # If compareWith is non-null, then it will be used to mask out those attributes that are the same in style and compareWith, for situations where we don't want to explicitly set inherited attributes.
1570
- # @param style [Wx::RTC::TextBoxAttr]
1571
- # @param compareWith [Wx::RTC::TextBoxAttr]
1572
- # @return [Boolean]
1573
- def apply(style, compareWith=nil) end
1574
-
1575
- # Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.
1576
- # @param attr [Wx::RTC::TextBoxAttr]
1577
- # @param clashingAttr [Wx::RTC::TextBoxAttr]
1578
- # @param absentAttr [Wx::RTC::TextBoxAttr]
1579
- # @return [void]
1580
- def collect_common_attributes(attr, clashingAttr, absentAttr) end
1581
-
1582
- # Removes the specified attributes from this object.
1583
- # @param attr [Wx::RTC::TextBoxAttr]
1584
- # @return [Boolean]
1585
- def remove_style(attr) end
1586
-
1587
- # Sets the flags.
1588
- # @param flags [Integer]
1589
- # @return [void]
1590
- def set_flags(flags) end
1591
- alias_method :flags=, :set_flags
1592
-
1593
- # Returns the flags.
1594
- # @return [Integer]
1595
- def get_flags; end
1596
- alias_method :flags, :get_flags
1597
-
1598
- # Is this flag present?
1599
- # @param flag [Wx::TextBoxAttrFlags]
1600
- # @return [Boolean]
1601
- def has_flag(flag) end
1602
- alias_method :has_flag?, :has_flag
1603
-
1604
- # Removes this flag.
1605
- # @param flag [Wx::TextBoxAttrFlags]
1606
- # @return [void]
1607
- def remove_flag(flag) end
1608
-
1609
- # Adds this flag.
1610
- # @param flag [Wx::TextBoxAttrFlags]
1611
- # @return [void]
1612
- def add_flag(flag) end
1613
-
1614
- # Returns true if no attributes are set.
1615
- # @return [Boolean]
1616
- def is_default; end
1617
- alias_method :default?, :is_default
1618
-
1619
- # Returns the float mode.
1620
- # @return [Wx::TextBoxAttrFloatStyle]
1621
- def get_float_mode; end
1622
- alias_method :float_mode, :get_float_mode
1623
-
1624
- # Sets the float mode.
1625
- # @param mode [Wx::TextBoxAttrFloatStyle]
1626
- # @return [void]
1627
- def set_float_mode(mode) end
1628
- alias_method :float_mode=, :set_float_mode
1629
-
1630
- # Returns true if float mode is active.
1631
- # @return [Boolean]
1632
- def has_float_mode; end
1633
- alias_method :has_float_mode?, :has_float_mode
1634
-
1635
- # Returns true if this object is floating.
1636
- # @return [Boolean]
1637
- def is_floating; end
1638
- alias_method :floating?, :is_floating
1639
-
1640
- # Returns the clear mode - whether to wrap text after object.
1641
- #
1642
- # Currently unimplemented.
1643
- # @return [Wx::TextBoxAttrClearStyle]
1644
- def get_clear_mode; end
1645
- alias_method :clear_mode, :get_clear_mode
1646
-
1647
- # Set the clear mode.
1648
- #
1649
- # Currently unimplemented.
1650
- # @param mode [Wx::TextBoxAttrClearStyle]
1651
- # @return [void]
1652
- def set_clear_mode(mode) end
1653
- alias_method :clear_mode=, :set_clear_mode
1654
-
1655
- # Returns true if we have a clear flag.
1656
- # @return [Boolean]
1657
- def has_clear_mode; end
1658
- alias_method :has_clear_mode?, :has_clear_mode
1659
-
1660
- # Returns the collapse mode - whether to collapse borders.
1661
- # @return [Wx::TextBoxAttrCollapseMode]
1662
- def get_collapse_borders; end
1663
- alias_method :collapse_borders, :get_collapse_borders
1664
-
1665
- # Sets the collapse mode - whether to collapse borders.
1666
- # @param collapse [Wx::TextBoxAttrCollapseMode]
1667
- # @return [void]
1668
- def set_collapse_borders(collapse) end
1669
- alias_method :collapse_borders=, :set_collapse_borders
1670
-
1671
- # Returns true if the collapse borders flag is present.
1672
- # @return [Boolean]
1673
- def has_collapse_borders; end
1674
- alias_method :has_collapse_borders?, :has_collapse_borders
1675
-
1676
- # Returns the whitespace mode.
1677
- # @return [Wx::TextBoxAttrWhitespaceMode]
1678
- def get_whitespace_mode; end
1679
- alias_method :whitespace_mode, :get_whitespace_mode
1680
-
1681
- # Sets the whitespace mode.
1682
- # @param whitespace [Wx::TextBoxAttrWhitespaceMode]
1683
- # @return [void]
1684
- def set_whitespace_mode(whitespace) end
1685
- alias_method :whitespace_mode=, :set_whitespace_mode
1686
-
1687
- # Returns true if the whitespace flag is present.
1688
- # @return [Boolean]
1689
- def has_whitespace_mode; end
1690
- alias_method :has_whitespace_mode?, :has_whitespace_mode
1691
-
1692
- # Returns true if the corner radius flag is present.
1693
- # @return [Boolean]
1694
- def has_corner_radius; end
1695
- alias_method :has_corner_radius?, :has_corner_radius
1696
-
1697
- # Returns the corner radius value.
1698
- # @return [Wx::RTC::TextAttrDimension]
1699
- def get_corner_radius; end
1700
- alias_method :corner_radius, :get_corner_radius
1701
-
1702
- # Sets the corner radius value.
1703
- # @param dim [Wx::RTC::TextAttrDimension]
1704
- # @return [void]
1705
- def set_corner_radius(dim) end
1706
- alias_method :corner_radius=, :set_corner_radius
1707
-
1708
- # Returns the vertical alignment.
1709
- # @return [Wx::TextBoxAttrVerticalAlignment]
1710
- def get_vertical_alignment; end
1711
- alias_method :vertical_alignment, :get_vertical_alignment
1712
-
1713
- # Sets the vertical alignment.
1714
- # @param verticalAlignment [Wx::TextBoxAttrVerticalAlignment]
1715
- # @return [void]
1716
- def set_vertical_alignment(verticalAlignment) end
1717
- alias_method :vertical_alignment=, :set_vertical_alignment
1718
-
1719
- # Returns true if a vertical alignment flag is present.
1720
- # @return [Boolean]
1721
- def has_vertical_alignment; end
1722
- alias_method :has_vertical_alignment?, :has_vertical_alignment
1723
-
1724
- # @return [Wx::RTC::TextAttrDimensions]
1725
- def get_margins; end
1726
- alias_method :margins, :get_margins
1727
-
1728
- # @return [Wx::RTC::TextAttrDimension]
1729
- def get_left_margin; end
1730
- alias_method :left_margin, :get_left_margin
1731
-
1732
- # @return [Wx::RTC::TextAttrDimension]
1733
- def get_right_margin; end
1734
- alias_method :right_margin, :get_right_margin
1735
-
1736
- # @return [Wx::RTC::TextAttrDimension]
1737
- def get_top_margin; end
1738
- alias_method :top_margin, :get_top_margin
1739
-
1740
- # @return [Wx::RTC::TextAttrDimension]
1741
- def get_bottom_margin; end
1742
- alias_method :bottom_margin, :get_bottom_margin
1743
-
1744
- # @return [Wx::RTC::TextAttrDimensions]
1745
- def get_position; end
1746
- alias_method :position, :get_position
1747
-
1748
- # @return [Wx::RTC::TextAttrDimension]
1749
- def get_left; end
1750
- alias_method :left, :get_left
1751
-
1752
- # @return [Wx::RTC::TextAttrDimension]
1753
- def get_right; end
1754
- alias_method :right, :get_right
1755
-
1756
- # @return [Wx::RTC::TextAttrDimension]
1757
- def get_top; end
1758
- alias_method :top, :get_top
1759
-
1760
- # @return [Wx::RTC::TextAttrDimension]
1761
- def get_bottom; end
1762
- alias_method :bottom, :get_bottom
1763
-
1764
- # @return [Wx::RTC::TextAttrDimensions]
1765
- def get_padding; end
1766
- alias_method :padding, :get_padding
1767
-
1768
- # @return [Wx::RTC::TextAttrDimension]
1769
- def get_left_padding; end
1770
- alias_method :left_padding, :get_left_padding
1771
-
1772
- # @return [Wx::RTC::TextAttrDimension]
1773
- def get_right_padding; end
1774
- alias_method :right_padding, :get_right_padding
1775
-
1776
- # @return [Wx::RTC::TextAttrDimension]
1777
- def get_top_padding; end
1778
- alias_method :top_padding, :get_top_padding
1779
-
1780
- # @return [Wx::RTC::TextAttrDimension]
1781
- def get_bottom_padding; end
1782
- alias_method :bottom_padding, :get_bottom_padding
1783
-
1784
- # @return [Wx::RTC::TextAttrBorders]
1785
- def get_border; end
1786
- alias_method :border, :get_border
1787
-
1788
- # @return [Wx::RTC::TextAttrBorder]
1789
- def get_left_border; end
1790
- alias_method :left_border, :get_left_border
1791
-
1792
- # @return [Wx::RTC::TextAttrBorder]
1793
- def get_top_border; end
1794
- alias_method :top_border, :get_top_border
1795
-
1796
- # @return [Wx::RTC::TextAttrBorder]
1797
- def get_right_border; end
1798
- alias_method :right_border, :get_right_border
1799
-
1800
- # @return [Wx::RTC::TextAttrBorder]
1801
- def get_bottom_border; end
1802
- alias_method :bottom_border, :get_bottom_border
1803
-
1804
- # @return [Wx::RTC::TextAttrBorders]
1805
- def get_outline; end
1806
- alias_method :outline, :get_outline
1807
-
1808
- # @return [Wx::RTC::TextAttrBorder]
1809
- def get_left_outline; end
1810
- alias_method :left_outline, :get_left_outline
1811
-
1812
- # @return [Wx::RTC::TextAttrBorder]
1813
- def get_top_outline; end
1814
- alias_method :top_outline, :get_top_outline
1815
-
1816
- # @return [Wx::RTC::TextAttrBorder]
1817
- def get_right_outline; end
1818
- alias_method :right_outline, :get_right_outline
1819
-
1820
- # @return [Wx::RTC::TextAttrBorder]
1821
- def get_bottom_outline; end
1822
- alias_method :bottom_outline, :get_bottom_outline
1823
-
1824
- # @return [Wx::RTC::TextAttrSize]
1825
- def get_size; end
1826
- alias_method :size, :get_size
1827
-
1828
- # @return [Wx::RTC::TextAttrSize]
1829
- def get_min_size; end
1830
- alias_method :min_size, :get_min_size
1831
-
1832
- # @return [Wx::RTC::TextAttrSize]
1833
- def get_max_size; end
1834
- alias_method :max_size, :get_max_size
1835
-
1836
- # Sets the object size.
1837
- # @param sz [Wx::RTC::TextAttrSize]
1838
- # @return [void]
1839
- def set_size(sz) end
1840
- alias_method :size=, :set_size
1841
-
1842
- # Sets the object minimum size.
1843
- # @param sz [Wx::RTC::TextAttrSize]
1844
- # @return [void]
1845
- def set_min_size(sz) end
1846
- alias_method :min_size=, :set_min_size
1847
-
1848
- # Sets the object maximum size.
1849
- # @param sz [Wx::RTC::TextAttrSize]
1850
- # @return [void]
1851
- def set_max_size(sz) end
1852
- alias_method :max_size=, :set_max_size
1853
-
1854
- # @return [Wx::RTC::TextAttrDimension]
1855
- def get_width; end
1856
- alias_method :width, :get_width
1857
-
1858
- # @return [Wx::RTC::TextAttrDimension]
1859
- def get_height; end
1860
- alias_method :height, :get_height
1861
-
1862
- # Returns the box style name.
1863
- # @return [Wx::String]
1864
- def get_box_style_name; end
1865
- alias_method :box_style_name, :get_box_style_name
1866
-
1867
- # Sets the box style name.
1868
- # @param name [String]
1869
- # @return [void]
1870
- def set_box_style_name(name) end
1871
- alias_method :box_style_name=, :set_box_style_name
1872
-
1873
- # Returns true if the box style name is present.
1874
- # @return [Boolean]
1875
- def has_box_style_name; end
1876
- alias_method :has_box_style_name?, :has_box_style_name
1877
-
1878
- # @return [Wx::RTC::TextAttrShadow]
1879
- def get_shadow; end
1880
- alias_method :shadow, :get_shadow
1881
-
1882
- end # TextBoxAttr
1883
-
1884
- # A class representing a rich text dimension, including units and position.
1885
- #
1886
- # Category: Rich Text
1887
- # @see Wx::RTC::RichTextAttr
1888
- # @see Wx::RTC::RichTextCtrl
1889
- # @see Wx::RTC::TextAttrDimensions
1890
- #
1891
- #
1892
- #
1893
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
1894
- # @wxrb_require USE_RICHTEXT
1895
- class TextAttrDimension < ::Object
1896
-
1897
- # @overload initialize()
1898
- # Default constructor.
1899
- # @return [Wx::RTC::TextAttrDimension]
1900
- # @overload initialize(value, units=Wx::RTC::TextAttrUnits::TEXT_ATTR_UNITS_TENTHS_MM)
1901
- # Constructor taking value and units flag.
1902
- # @param value [Integer]
1903
- # @param units [Wx::TextAttrUnits]
1904
- # @return [Wx::RTC::TextAttrDimension]
1905
- def initialize(*args) end
1906
-
1907
- # Resets the dimension value and flags.
1908
- # @return [void]
1909
- def reset; end
1910
-
1911
- # Partial equality test.
1912
- #
1913
- # If weakTest is true, attributes of this object do not have to be present if those attributes of dim are present. If weakTest is false, the function will fail if an attribute is present in dim but not in this object.
1914
- # @param dim [Wx::RTC::TextAttrDimension]
1915
- # @param weakTest [Boolean]
1916
- # @return [Boolean]
1917
- def eq_partial(dim, weakTest=true) end
1918
-
1919
- # Apply the dimension, but not those identical to compareWith if present.
1920
- # @param dim [Wx::RTC::TextAttrDimension]
1921
- # @param compareWith [Wx::RTC::TextAttrDimension]
1922
- # @return [Boolean]
1923
- def apply(dim, compareWith=nil) end
1924
-
1925
- # Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.
1926
- # @param attr [Wx::RTC::TextAttrDimension]
1927
- # @param clashingAttr [Wx::RTC::TextAttrDimension]
1928
- # @param absentAttr [Wx::RTC::TextAttrDimension]
1929
- # @return [void]
1930
- def collect_common_attributes(attr, clashingAttr, absentAttr) end
1931
-
1932
- # Equality operator.
1933
- # @param dim [Wx::RTC::TextAttrDimension]
1934
- # @return [Boolean]
1935
- def ==(dim) end
1936
-
1937
- # Returns the integer value of the dimension.
1938
- # @return [Integer]
1939
- def get_value; end
1940
- alias_method :value, :get_value
1941
-
1942
- # Returns the floating-pointing value of the dimension in mm.
1943
- # @return [Float]
1944
- def get_value_mm; end
1945
- alias_method :value_mm, :get_value_mm
1946
-
1947
- # Sets the value of the dimension in mm.
1948
- # @param value [Float]
1949
- # @return [void]
1950
- def set_value_mm(value) end
1951
- alias_method :value_mm=, :set_value_mm
1952
-
1953
- # @overload set_value(value)
1954
- # Sets the integer value of the dimension.
1955
- # @param value [Integer]
1956
- # @return [void]
1957
- # @overload set_value(value, flags)
1958
- # Sets the integer value of the dimension, passing dimension flags.
1959
- # @param value [Integer]
1960
- # @param flags [Wx::TextAttrDimensionFlags]
1961
- # @return [void]
1962
- # @overload set_value(value, units)
1963
- # Sets the integer value and units.
1964
- # @param value [Integer]
1965
- # @param units [Wx::TextAttrUnits]
1966
- # @return [void]
1967
- # @overload set_value(dim)
1968
- # Sets the dimension.
1969
- # @param dim [Wx::RTC::TextAttrDimension]
1970
- # @return [void]
1971
- def set_value(*args) end
1972
- alias_method :value=, :set_value
1973
-
1974
- # Gets the units of the dimension.
1975
- # @return [Wx::TextAttrUnits]
1976
- def get_units; end
1977
- alias_method :units, :get_units
1978
-
1979
- # Sets the units of the dimension.
1980
- # @param units [Wx::TextAttrUnits]
1981
- # @return [void]
1982
- def set_units(units) end
1983
- alias_method :units=, :set_units
1984
-
1985
- # Gets the position flags.
1986
- # @return [Wx::TextBoxAttrPosition]
1987
- def get_position; end
1988
- alias_method :position, :get_position
1989
-
1990
- # Sets the position flags.
1991
- # @param pos [Wx::TextBoxAttrPosition]
1992
- # @return [void]
1993
- def set_position(pos) end
1994
- alias_method :position=, :set_position
1995
-
1996
- # Returns true if the dimension is valid.
1997
- # @return [Boolean]
1998
- def is_valid; end
1999
- alias_method :valid?, :is_valid
2000
-
2001
- # Sets the valid flag.
2002
- # @param b [Boolean]
2003
- # @return [void]
2004
- def set_valid(b) end
2005
- alias_method :valid=, :set_valid
2006
-
2007
- # Gets the dimension flags.
2008
- # @return [Wx::TextAttrDimensionFlags]
2009
- def get_flags; end
2010
- alias_method :flags, :get_flags
2011
-
2012
- # Sets the dimension flags.
2013
- # @param flags [Wx::TextAttrDimensionFlags]
2014
- # @return [void]
2015
- def set_flags(flags) end
2016
- alias_method :flags=, :set_flags
2017
-
2018
- end # TextAttrDimension
2019
-
2020
- # A class for left, right, top and bottom dimensions.
2021
- #
2022
- # Category: Rich Text
2023
- # @see Wx::RTC::RichTextAttr
2024
- # @see Wx::RTC::RichTextCtrl
2025
- # @see Wx::RTC::TextAttrDimension
2026
- #
2027
- #
2028
- #
2029
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2030
- # @wxrb_require USE_RICHTEXT
2031
- class TextAttrDimensions < ::Object
2032
-
2033
- # Default constructor.
2034
- # @return [Wx::RTC::TextAttrDimensions]
2035
- def initialize; end
2036
-
2037
- # Resets the value and flags for all dimensions.
2038
- # @return [void]
2039
- def reset; end
2040
-
2041
- # Equality operator.
2042
- # @param dims [Wx::RTC::TextAttrDimensions]
2043
- # @return [Boolean]
2044
- def ==(dims) end
2045
-
2046
- # Partial equality test.
2047
- #
2048
- # If weakTest is true, attributes of this object do not have to be present if those attributes of dims are present. If weakTest is false, the function will fail if an attribute is present in dims but not in this object.
2049
- # @param dims [Wx::RTC::TextAttrDimensions]
2050
- # @param weakTest [Boolean]
2051
- # @return [Boolean]
2052
- def eq_partial(dims, weakTest=true) end
2053
-
2054
- # Apply to 'this', but not if the same as compareWith.
2055
- # @param dims [Wx::RTC::TextAttrDimensions]
2056
- # @param compareWith [Wx::RTC::TextAttrDimensions]
2057
- # @return [Boolean]
2058
- def apply(dims, compareWith=nil) end
2059
-
2060
- # Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.
2061
- # @param attr [Wx::RTC::TextAttrDimensions]
2062
- # @param clashingAttr [Wx::RTC::TextAttrDimensions]
2063
- # @param absentAttr [Wx::RTC::TextAttrDimensions]
2064
- # @return [void]
2065
- def collect_common_attributes(attr, clashingAttr, absentAttr) end
2066
-
2067
- # Remove specified attributes from this object.
2068
- # @param attr [Wx::RTC::TextAttrDimensions]
2069
- # @return [Boolean]
2070
- def remove_style(attr) end
2071
-
2072
- # Gets the left dimension.
2073
- # @return [Wx::RTC::TextAttrDimension]
2074
- def get_left; end
2075
- alias_method :left, :get_left
2076
-
2077
- # Gets the right dimension.
2078
- # @return [Wx::RTC::TextAttrDimension]
2079
- def get_right; end
2080
- alias_method :right, :get_right
2081
-
2082
- # Gets the top dimension.
2083
- # @return [Wx::RTC::TextAttrDimension]
2084
- def get_top; end
2085
- alias_method :top, :get_top
2086
-
2087
- # Gets the bottom dimension.
2088
- # @return [Wx::RTC::TextAttrDimension]
2089
- def get_bottom; end
2090
- alias_method :bottom, :get_bottom
2091
-
2092
- # Are all dimensions valid?
2093
- # @return [Boolean]
2094
- def is_valid; end
2095
- alias_method :valid?, :is_valid
2096
-
2097
- end # TextAttrDimensions
2098
-
2099
- # A class representing a shadow.
2100
- #
2101
- # Category: Rich Text
2102
- # @see Wx::RTC::RichTextAttr
2103
- # @see Wx::RTC::RichTextCtrl
2104
- #
2105
- #
2106
- #
2107
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2108
- # @wxrb_require USE_RICHTEXT
2109
- class TextAttrShadow < ::Object
2110
-
2111
- # Default constructor.
2112
- # @return [Wx::RTC::TextAttrShadow]
2113
- def initialize; end
2114
-
2115
- # Equality operator.
2116
- # @param shadow [Wx::RTC::TextAttrShadow]
2117
- # @return [Boolean]
2118
- def ==(shadow) end
2119
-
2120
- # Resets the shadow.
2121
- # @return [void]
2122
- def reset; end
2123
-
2124
- # Partial equality test.
2125
- #
2126
- # If weakTest is true, attributes of this object do not have to be present if those attributes of border are present. If weakTest is false, the function will fail if an attribute is present in border but not in this object.
2127
- # @param shadow [Wx::RTC::TextAttrShadow]
2128
- # @param weakTest [Boolean]
2129
- # @return [Boolean]
2130
- def eq_partial(shadow, weakTest=true) end
2131
-
2132
- # Applies the border to this object, but not if the same as compareWith.
2133
- # @param shadow [Wx::RTC::TextAttrShadow]
2134
- # @param compareWith [Wx::RTC::TextAttrShadow]
2135
- # @return [Boolean]
2136
- def apply(shadow, compareWith=nil) end
2137
-
2138
- # Removes the specified attributes from this object.
2139
- # @param attr [Wx::RTC::TextAttrShadow]
2140
- # @return [Boolean]
2141
- def remove_style(attr) end
2142
-
2143
- # Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.
2144
- # @param attr [Wx::RTC::TextAttrShadow]
2145
- # @param clashingAttr [Wx::RTC::TextAttrShadow]
2146
- # @param absentAttr [Wx::RTC::TextAttrShadow]
2147
- # @return [void]
2148
- def collect_common_attributes(attr, clashingAttr, absentAttr) end
2149
-
2150
- # @overload set_colour(colour)
2151
- # Sets the shadow colour.
2152
- # @param colour [Integer]
2153
- # @return [void]
2154
- # @overload set_colour(colour)
2155
- # Sets the shadow colour.
2156
- # @param colour [Wx::Colour,String,Symbol]
2157
- # @return [void]
2158
- def set_colour(*args) end
2159
- alias_method :colour=, :set_colour
2160
-
2161
- # Gets the colour as a long.
2162
- # @return [Integer]
2163
- def get_colour_long; end
2164
- alias_method :colour_long, :get_colour_long
2165
-
2166
- # Gets the colour.
2167
- # @return [Wx::Colour]
2168
- def get_colour; end
2169
- alias_method :colour, :get_colour
2170
-
2171
- # True if the shadow has a valid colour.
2172
- # @return [Boolean]
2173
- def has_colour; end
2174
- alias_method :has_colour?, :has_colour
2175
-
2176
- # @return [Wx::RTC::TextAttrDimension]
2177
- def get_offset_x; end
2178
- alias_method :offset_x, :get_offset_x
2179
-
2180
- # Sets the shadow horizontal offset.
2181
- # @param offset [Wx::RTC::TextAttrDimension]
2182
- # @return [void]
2183
- def set_offset_x(offset) end
2184
- alias_method :offset_x=, :set_offset_x
2185
-
2186
- # @return [Wx::RTC::TextAttrDimension]
2187
- def get_offset_y; end
2188
- alias_method :offset_y, :get_offset_y
2189
-
2190
- # Sets the shadow vertical offset.
2191
- # @param offset [Wx::RTC::TextAttrDimension]
2192
- # @return [void]
2193
- def set_offset_y(offset) end
2194
- alias_method :offset_y=, :set_offset_y
2195
-
2196
- # @return [Wx::RTC::TextAttrDimension]
2197
- def get_spread; end
2198
- alias_method :spread, :get_spread
2199
-
2200
- # Sets the shadow spread size.
2201
- # @param spread [Wx::RTC::TextAttrDimension]
2202
- # @return [void]
2203
- def set_spread(spread) end
2204
- alias_method :spread=, :set_spread
2205
-
2206
- # @return [Wx::RTC::TextAttrDimension]
2207
- def get_blur_distance; end
2208
- alias_method :blur_distance, :get_blur_distance
2209
-
2210
- # Sets the shadow blur distance.
2211
- # @param blur [Wx::RTC::TextAttrDimension]
2212
- # @return [void]
2213
- def set_blur_distance(blur) end
2214
- alias_method :blur_distance=, :set_blur_distance
2215
-
2216
- # @return [Wx::RTC::TextAttrDimension]
2217
- def get_opacity; end
2218
- alias_method :opacity, :get_opacity
2219
-
2220
- # Returns true if the dimension is valid.
2221
- # @return [Boolean]
2222
- def is_valid; end
2223
- alias_method :valid?, :is_valid
2224
-
2225
- # Sets the valid flag.
2226
- # @param b [Boolean]
2227
- # @return [void]
2228
- def set_valid(b) end
2229
- alias_method :valid=, :set_valid
2230
-
2231
- # Returns the border flags.
2232
- # @return [Integer]
2233
- def get_flags; end
2234
- alias_method :flags, :get_flags
2235
-
2236
- # Sets the border flags.
2237
- # @param flags [Integer]
2238
- # @return [void]
2239
- def set_flags(flags) end
2240
- alias_method :flags=, :set_flags
2241
-
2242
- # Adds a border flag.
2243
- # @param flag [Integer]
2244
- # @return [void]
2245
- def add_flag(flag) end
2246
-
2247
- # Removes a border flag.
2248
- # @param flag [Integer]
2249
- # @return [void]
2250
- def remove_flag(flag) end
2251
-
2252
- # Sets the shadow opacity.
2253
- # @param opacity [Wx::RTC::TextAttrDimension]
2254
- # @return [void]
2255
- def set_opacity(opacity) end
2256
- alias_method :opacity=, :set_opacity
2257
-
2258
- # True if the shadow has no attributes set.
2259
- # @return [Boolean]
2260
- def is_default; end
2261
- alias_method :default?, :is_default
2262
-
2263
- end # TextAttrShadow
2264
-
2265
- # A class representing a rich text object border.
2266
- #
2267
- # Category: Rich Text
2268
- # @see Wx::RTC::RichTextAttr
2269
- # @see Wx::RTC::RichTextCtrl
2270
- # @see wxRichTextAttrBorders
2271
- #
2272
- #
2273
- #
2274
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2275
- # @wxrb_require USE_RICHTEXT
2276
- class TextAttrBorder < ::Object
2277
-
2278
- # Default constructor.
2279
- # @return [Wx::RTC::TextAttrBorder]
2280
- def initialize; end
2281
-
2282
- # Equality operator.
2283
- # @param border [Wx::RTC::TextAttrBorder]
2284
- # @return [Boolean]
2285
- def ==(border) end
2286
-
2287
- # Resets the border style, colour, width and flags.
2288
- # @return [void]
2289
- def reset; end
2290
-
2291
- # Partial equality test.
2292
- #
2293
- # If weakTest is true, attributes of this object do not have to be present if those attributes of border are present. If weakTest is false, the function will fail if an attribute is present in border but not in this object.
2294
- # @param border [Wx::RTC::TextAttrBorder]
2295
- # @param weakTest [Boolean]
2296
- # @return [Boolean]
2297
- def eq_partial(border, weakTest=true) end
2298
-
2299
- # Applies the border to this object, but not if the same as compareWith.
2300
- # @param border [Wx::RTC::TextAttrBorder]
2301
- # @param compareWith [Wx::RTC::TextAttrBorder]
2302
- # @return [Boolean]
2303
- def apply(border, compareWith=nil) end
2304
-
2305
- # Removes the specified attributes from this object.
2306
- # @param attr [Wx::RTC::TextAttrBorder]
2307
- # @return [Boolean]
2308
- def remove_style(attr) end
2309
-
2310
- # Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.
2311
- # @param attr [Wx::RTC::TextAttrBorder]
2312
- # @param clashingAttr [Wx::RTC::TextAttrBorder]
2313
- # @param absentAttr [Wx::RTC::TextAttrBorder]
2314
- # @return [void]
2315
- def collect_common_attributes(attr, clashingAttr, absentAttr) end
2316
-
2317
- # Sets the border style.
2318
- # @param style [Integer]
2319
- # @return [void]
2320
- def set_style(style) end
2321
- alias_method :style=, :set_style
2322
-
2323
- # Gets the border style.
2324
- # @return [Integer]
2325
- def get_style; end
2326
- alias_method :style, :get_style
2327
-
2328
- # @overload set_colour(colour)
2329
- # Sets the border colour.
2330
- # @param colour [Integer]
2331
- # @return [void]
2332
- # @overload set_colour(colour)
2333
- # Sets the border colour.
2334
- # @param colour [Wx::Colour,String,Symbol]
2335
- # @return [void]
2336
- def set_colour(*args) end
2337
- alias_method :colour=, :set_colour
2338
-
2339
- # Gets the colour as a long.
2340
- # @return [Integer]
2341
- def get_colour_long; end
2342
- alias_method :colour_long, :get_colour_long
2343
-
2344
- # Gets the colour.
2345
- # @return [Wx::Colour]
2346
- def get_colour; end
2347
- alias_method :colour, :get_colour
2348
-
2349
- # @return [Wx::RTC::TextAttrDimension]
2350
- def get_width; end
2351
- alias_method :width, :get_width
2352
-
2353
- # @overload set_width(width)
2354
- # Sets the border width.
2355
- # @param width [Wx::RTC::TextAttrDimension]
2356
- # @return [void]
2357
- # @overload set_width(value, units=Wx::RTC::TextAttrUnits::TEXT_ATTR_UNITS_TENTHS_MM)
2358
- # Sets the border width.
2359
- # @param value [Integer]
2360
- # @param units [Wx::TextAttrUnits]
2361
- # @return [void]
2362
- def set_width(*args) end
2363
- alias_method :width=, :set_width
2364
-
2365
- # True if the border has a valid style.
2366
- # @return [Boolean]
2367
- def has_style; end
2368
- alias_method :has_style?, :has_style
2369
-
2370
- # True if the border has a valid colour.
2371
- # @return [Boolean]
2372
- def has_colour; end
2373
- alias_method :has_colour?, :has_colour
2374
-
2375
- # True if the border has a valid width.
2376
- # @return [Boolean]
2377
- def has_width; end
2378
- alias_method :has_width?, :has_width
2379
-
2380
- # True if the border is valid.
2381
- # @return [Boolean]
2382
- def is_valid; end
2383
- alias_method :valid?, :is_valid
2384
-
2385
- # True if the border has no attributes set.
2386
- # @return [Boolean]
2387
- def is_default; end
2388
- alias_method :default?, :is_default
2389
-
2390
- # Set the valid flag for this border.
2391
- # @return [void]
2392
- def make_valid; end
2393
-
2394
- # Returns the border flags.
2395
- # @return [Integer]
2396
- def get_flags; end
2397
- alias_method :flags, :get_flags
2398
-
2399
- # Sets the border flags.
2400
- # @param flags [Integer]
2401
- # @return [void]
2402
- def set_flags(flags) end
2403
- alias_method :flags=, :set_flags
2404
-
2405
- # Adds a border flag.
2406
- # @param flag [Integer]
2407
- # @return [void]
2408
- def add_flag(flag) end
2409
-
2410
- # Removes a border flag.
2411
- # @param flag [Integer]
2412
- # @return [void]
2413
- def remove_flag(flag) end
2414
-
2415
- end # TextAttrBorder
2416
-
2417
- # A class representing a rich text object's borders.
2418
- #
2419
- # Category: Rich Text
2420
- # @see Wx::RTC::RichTextAttr
2421
- # @see Wx::RTC::RichTextCtrl
2422
- # @see wxRichTextAttrBorder
2423
- #
2424
- #
2425
- #
2426
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2427
- # @wxrb_require USE_RICHTEXT
2428
- class TextAttrBorders < ::Object
2429
-
2430
- # Default constructor.
2431
- # @return [Wx::RTC::TextAttrBorders]
2432
- def initialize; end
2433
-
2434
- # Equality operator.
2435
- # @param borders [Wx::RTC::TextAttrBorders]
2436
- # @return [Boolean]
2437
- def ==(borders) end
2438
-
2439
- # Sets the style of all borders.
2440
- # @param style [Integer]
2441
- # @return [void]
2442
- def set_style(style) end
2443
- alias_method :style=, :set_style
2444
-
2445
- # @overload set_colour(colour)
2446
- # Sets colour of all borders.
2447
- # @param colour [Integer]
2448
- # @return [void]
2449
- # @overload set_colour(colour)
2450
- # Sets the colour for all borders.
2451
- # @param colour [Wx::Colour,String,Symbol]
2452
- # @return [void]
2453
- def set_colour(*args) end
2454
- alias_method :colour=, :set_colour
2455
-
2456
- # @overload set_width(width)
2457
- # Sets the width of all borders.
2458
- # @param width [Wx::RTC::TextAttrDimension]
2459
- # @return [void]
2460
- # @overload set_width(value, units=Wx::RTC::TextAttrUnits::TEXT_ATTR_UNITS_TENTHS_MM)
2461
- # Sets the width of all borders.
2462
- # @param value [Integer]
2463
- # @param units [Wx::TextAttrUnits]
2464
- # @return [void]
2465
- def set_width(*args) end
2466
- alias_method :width=, :set_width
2467
-
2468
- # Resets all borders.
2469
- # @return [void]
2470
- def reset; end
2471
-
2472
- # Partial equality test.
2473
- #
2474
- # If weakTest is true, attributes of this object do not have to be present if those attributes of borders are present. If weakTest is false, the function will fail if an attribute is present in borders but not in this object.
2475
- # @param borders [Wx::RTC::TextAttrBorders]
2476
- # @param weakTest [Boolean]
2477
- # @return [Boolean]
2478
- def eq_partial(borders, weakTest=true) end
2479
-
2480
- # Applies border to this object, but not if the same as compareWith.
2481
- # @param borders [Wx::RTC::TextAttrBorders]
2482
- # @param compareWith [Wx::RTC::TextAttrBorders]
2483
- # @return [Boolean]
2484
- def apply(borders, compareWith=nil) end
2485
-
2486
- # Removes the specified attributes from this object.
2487
- # @param attr [Wx::RTC::TextAttrBorders]
2488
- # @return [Boolean]
2489
- def remove_style(attr) end
2490
-
2491
- # Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.
2492
- # @param attr [Wx::RTC::TextAttrBorders]
2493
- # @param clashingAttr [Wx::RTC::TextAttrBorders]
2494
- # @param absentAttr [Wx::RTC::TextAttrBorders]
2495
- # @return [void]
2496
- def collect_common_attributes(attr, clashingAttr, absentAttr) end
2497
-
2498
- # Returns true if at least one border is valid.
2499
- # @return [Boolean]
2500
- def is_valid; end
2501
- alias_method :valid?, :is_valid
2502
-
2503
- # Returns the left border.
2504
- # @return [Wx::RTC::TextAttrBorder]
2505
- def get_left; end
2506
- alias_method :left, :get_left
2507
-
2508
- # Returns the right border.
2509
- # @return [Wx::RTC::TextAttrBorder]
2510
- def get_right; end
2511
- alias_method :right, :get_right
2512
-
2513
- # Returns the top border.
2514
- # @return [Wx::RTC::TextAttrBorder]
2515
- def get_top; end
2516
- alias_method :top, :get_top
2517
-
2518
- # Returns the bottom border.
2519
- # @return [Wx::RTC::TextAttrBorder]
2520
- def get_bottom; end
2521
- alias_method :bottom, :get_bottom
2522
-
2523
- end # TextAttrBorders
2524
-
2525
- # A class for representing width and height.
2526
- #
2527
- # Category: Rich Text
2528
- # @see Wx::RTC::RichTextAttr
2529
- # @see Wx::RTC::RichTextCtrl
2530
- # @see Wx::RTC::TextAttrDimension
2531
- #
2532
- #
2533
- #
2534
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2535
- # @wxrb_require USE_RICHTEXT
2536
- class TextAttrSize < ::Object
2537
-
2538
- # Default constructor.
2539
- # @return [Wx::RTC::TextAttrSize]
2540
- def initialize; end
2541
-
2542
- # Resets the width and height dimensions.
2543
- # @return [void]
2544
- def reset; end
2545
-
2546
- # Equality operator.
2547
- # @param size [Wx::RTC::TextAttrSize]
2548
- # @return [Boolean]
2549
- def ==(size) end
2550
-
2551
- # Partial equality test.
2552
- #
2553
- # If weakTest is true, attributes of this object do not have to be present if those attributes of size are present. If weakTest is false, the function will fail if an attribute is present in size but not in this object.
2554
- # @param size [Wx::RTC::TextAttrSize]
2555
- # @param weakTest [Boolean]
2556
- # @return [Boolean]
2557
- def eq_partial(size, weakTest=true) end
2558
-
2559
- # Apply to this object, but not if the same as compareWith.
2560
- # @param dims [Wx::RTC::TextAttrSize]
2561
- # @param compareWith [Wx::RTC::TextAttrSize]
2562
- # @return [Boolean]
2563
- def apply(dims, compareWith=nil) end
2564
-
2565
- # Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.
2566
- # @param attr [Wx::RTC::TextAttrSize]
2567
- # @param clashingAttr [Wx::RTC::TextAttrSize]
2568
- # @param absentAttr [Wx::RTC::TextAttrSize]
2569
- # @return [void]
2570
- def collect_common_attributes(attr, clashingAttr, absentAttr) end
2571
-
2572
- # Removes the specified attributes from this object.
2573
- # @param attr [Wx::RTC::TextAttrSize]
2574
- # @return [Boolean]
2575
- def remove_style(attr) end
2576
-
2577
- # @return [Wx::RTC::TextAttrDimension]
2578
- def get_width; end
2579
- alias_method :width, :get_width
2580
-
2581
- # @overload set_width(value, flags)
2582
- # Sets the width.
2583
- # @param value [Integer]
2584
- # @param flags [Wx::TextAttrDimensionFlags]
2585
- # @return [void]
2586
- # @overload set_width(value, units)
2587
- # Sets the width.
2588
- # @param value [Integer]
2589
- # @param units [Wx::TextAttrUnits]
2590
- # @return [void]
2591
- # @overload set_width(dim)
2592
- # Sets the width.
2593
- # @param dim [Wx::RTC::TextAttrDimension]
2594
- # @return [void]
2595
- def set_width(*args) end
2596
- alias_method :width=, :set_width
2597
-
2598
- # @return [Wx::RTC::TextAttrDimension]
2599
- def get_height; end
2600
- alias_method :height, :get_height
2601
-
2602
- # @overload set_height(value, flags)
2603
- # Sets the height.
2604
- # @param value [Integer]
2605
- # @param flags [Wx::TextAttrDimensionFlags]
2606
- # @return [void]
2607
- # @overload set_height(value, units)
2608
- # Sets the height.
2609
- # @param value [Integer]
2610
- # @param units [Wx::TextAttrUnits]
2611
- # @return [void]
2612
- # @overload set_height(dim)
2613
- # Sets the height.
2614
- # @param dim [Wx::RTC::TextAttrDimension]
2615
- # @return [void]
2616
- def set_height(*args) end
2617
- alias_method :height=, :set_height
2618
-
2619
- # Is the size valid?
2620
- # @return [Boolean]
2621
- def is_valid; end
2622
- alias_method :valid?, :is_valid
2623
-
2624
- end # TextAttrSize
2625
-
2626
- # Stores selection information.
2627
- #
2628
- # The selection does not have to be contiguous, though currently non-contiguous selections are only supported for a range of table cells (a geometric block of cells can consist of a set of non-contiguous positions).
2629
- # The selection consists of an array of ranges, and the container that is the context for the selection. It follows that a single selection object can only represent ranges with the same parent container.
2630
- #
2631
- # Category: Rich Text
2632
- # @see Wx::RTC::RichTextBuffer
2633
- # @see Wx::RTC::RichTextCtrl
2634
- #
2635
- #
2636
- #
2637
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2638
- # @wxrb_require USE_RICHTEXT
2639
- class RichTextSelection < ::Object
2640
-
2641
- # @overload initialize(sel)
2642
- # Copy constructor.
2643
- # @param sel [Wx::RTC::RichTextSelection]
2644
- # @return [Wx::RTC::RichTextSelection]
2645
- # @overload initialize(range, container)
2646
- # Creates a selection from a range and a container.
2647
- # @param range [Range]
2648
- # @param container [Wx::RTC::RichTextParagraphLayoutBox]
2649
- # @return [Wx::RTC::RichTextSelection]
2650
- # @overload initialize()
2651
- # Default constructor.
2652
- # @return [Wx::RTC::RichTextSelection]
2653
- def initialize(*args) end
2654
-
2655
- # Resets the selection.
2656
- # @return [void]
2657
- def reset; end
2658
-
2659
- # @overload set(range, container)
2660
- # Sets the selection.
2661
- # @param range [Range]
2662
- # @param container [Wx::RTC::RichTextParagraphLayoutBox]
2663
- # @return [void]
2664
- # @overload set(ranges, container)
2665
- # Sets the selections from an array of ranges and a container object.
2666
- # @param ranges [Array<Range>]
2667
- # @param container [Wx::RTC::RichTextParagraphLayoutBox]
2668
- # @return [void]
2669
- def set(*args) end
2670
-
2671
- # Adds a range to the selection.
2672
- # @param range [Range]
2673
- # @return [void]
2674
- def add(range) end
2675
-
2676
- # Copies from sel.
2677
- # @param sel [Wx::RTC::RichTextSelection]
2678
- # @return [void]
2679
- def copy(sel) end
2680
-
2681
- # Equality operator.
2682
- # @param sel [Wx::RTC::RichTextSelection]
2683
- # @return [Boolean]
2684
- def ==(sel) end
2685
-
2686
- # Returns the selection ranges.
2687
- # @return [Array<Range>]
2688
- def get_ranges; end
2689
- alias_method :ranges, :get_ranges
2690
-
2691
- # Sets the selection ranges.
2692
- # @param ranges [Array<Range>]
2693
- # @return [void]
2694
- def set_ranges(ranges) end
2695
- alias_method :ranges=, :set_ranges
2696
-
2697
- # Returns the number of ranges in the selection.
2698
- # @return [Integer]
2699
- def get_count; end
2700
- alias_method :count, :get_count
2701
-
2702
- # @overload get_range(i)
2703
- # Returns the range at the given index.
2704
- # @param i [Integer]
2705
- # @return [Range]
2706
- # @overload get_range()
2707
- # Returns the first range if there is one, otherwise {Wx::RICHTEXT_NO_SELECTION}.
2708
- # @return [Range]
2709
- def get_range(*args) end
2710
- alias_method :range, :get_range
2711
-
2712
- # Sets a single range.
2713
- # @param range [Range]
2714
- # @return [void]
2715
- def set_range(range) end
2716
- alias_method :range=, :set_range
2717
-
2718
- # Returns the container for which the selection is valid.
2719
- # @return [Wx::RTC::RichTextParagraphLayoutBox]
2720
- def get_container; end
2721
- alias_method :container, :get_container
2722
-
2723
- # Sets the container for which the selection is valid.
2724
- # @param container [Wx::RTC::RichTextParagraphLayoutBox]
2725
- # @return [void]
2726
- def set_container(container) end
2727
- alias_method :container=, :set_container
2728
-
2729
- # Returns true if the selection is valid.
2730
- # @return [Boolean]
2731
- def is_valid; end
2732
- alias_method :valid?, :is_valid
2733
-
2734
- # Returns the selection appropriate to the specified object, if any; returns an empty array if none at the level of the object's container.
2735
- # @param obj [Wx::RTC::RichTextObject]
2736
- # @return [Array<Range>]
2737
- def get_selection_for_object(obj) end
2738
- alias_method :selection_for_object, :get_selection_for_object
2739
-
2740
- # @overload within_selection(pos, obj)
2741
- # Returns true if the given position is within the selection.
2742
- # @param pos [Integer]
2743
- # @param obj [Wx::RTC::RichTextObject]
2744
- # @return [Boolean]
2745
- # @overload within_selection(pos)
2746
- # Returns true if the given position is within the selection.
2747
- # @param pos [Integer]
2748
- # @return [Boolean]
2749
- def within_selection(*args) end
2750
-
2751
- # @overload self.within_selection(pos, ranges)
2752
- # Returns true if the given position is within the selection range.
2753
- # @param pos [Integer]
2754
- # @param ranges [Array<Range>]
2755
- # @return [Boolean]
2756
- # @overload self.within_selection(range, ranges)
2757
- # Returns true if the given range is within the selection range.
2758
- # @param range [Range]
2759
- # @param ranges [Array<Range>]
2760
- # @return [Boolean]
2761
- def self.within_selection(*args) end
2762
-
2763
- end # RichTextSelection
2764
-
2765
- # A simple property class using {Wx::Variants}.
2766
- #
2767
- # This is used to give each rich text object the ability to store custom properties that can be used by the application.
2768
- #
2769
- # Category: Rich Text
2770
- # @see Wx::RTC::RichTextBuffer
2771
- # @see Wx::RTC::RichTextObject
2772
- # @see Wx::RTC::RichTextCtrl
2773
- #
2774
- #
2775
- #
2776
- # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
2777
- # @wxrb_require USE_RICHTEXT
2778
- class RichTextProperties < Object
2779
-
2780
- # @overload initialize()
2781
- # Default constructor.
2782
- # @return [Wx::RTC::RichTextProperties]
2783
- # @overload initialize(props)
2784
- # Copy constructor.
2785
- # @param props [Wx::RTC::RichTextProperties]
2786
- # @return [Wx::RTC::RichTextProperties]
2787
- def initialize(*args) end
2788
-
2789
- # Equality operator.
2790
- # @param props [Wx::RTC::RichTextProperties]
2791
- # @return [Boolean]
2792
- def ==(props) end
2793
-
2794
- # Copies from props.
2795
- # @param props [Wx::RTC::RichTextProperties]
2796
- # @return [void]
2797
- def copy(props) end
2798
-
2799
- # Clears the properties.
2800
- # @return [void]
2801
- def clear; end
2802
-
2803
- # Returns the array of variants implementing the properties.
2804
- # @return [Array<Wx::Variant>]
2805
- def get_properties; end
2806
- alias_method :properties, :get_properties
2807
-
2808
- # Sets the array of variants.
2809
- # @param props [Array<Wx::Variant>]
2810
- # @return [void]
2811
- def set_properties(props) end
2812
- alias_method :properties=, :set_properties
2813
-
2814
- # Returns all the property names.
2815
- # @return [Array<String>]
2816
- def get_property_names; end
2817
- alias_method :property_names, :get_property_names
2818
-
2819
- # Returns a count of the properties.
2820
- # @return [Integer]
2821
- def get_count; end
2822
- alias_method :count, :get_count
2823
-
2824
- # Returns true if the given property is found.
2825
- # @param name [String]
2826
- # @return [Boolean]
2827
- def has_property(name) end
2828
- alias_method :has_property?, :has_property
2829
-
2830
- # Finds the given property.
2831
- # @param name [String]
2832
- # @return [Integer]
2833
- def find(name) end
2834
-
2835
- # Removes the given property.
2836
- # @param name [String]
2837
- # @return [Boolean]
2838
- def remove(name) end
2839
-
2840
- # Gets the property variant by name.
2841
- # @param name [String]
2842
- # @return [Wx::Variant]
2843
- def get_property(name) end
2844
- alias_method :property, :get_property
2845
-
2846
- # Finds or creates a property with the given name, returning a pointer to the variant.
2847
- # @param name [String]
2848
- # @return [Wx::Variant]
2849
- def find_or_create_property(name) end
2850
-
2851
- # Gets the value of the named property as a string.
2852
- # @param name [String]
2853
- # @return [String]
2854
- def get_property_string(name) end
2855
- alias_method :property_string, :get_property_string
2856
-
2857
- # Gets the value of the named property as a long integer.
2858
- # @param name [String]
2859
- # @return [Integer]
2860
- def get_property_long(name) end
2861
- alias_method :property_long, :get_property_long
2862
-
2863
- # Gets the value of the named property as a boolean.
2864
- # @param name [String]
2865
- # @return [Boolean]
2866
- def get_property_bool(name) end
2867
- alias_method :property_bool, :get_property_bool
2868
-
2869
- # Gets the value of the named property as a double.
2870
- # @param name [String]
2871
- # @return [Float]
2872
- def get_property_double(name) end
2873
- alias_method :property_double, :get_property_double
2874
-
2875
- # @overload set_property(variant)
2876
- # Sets the property by passing a variant which contains a name and value.
2877
- # @param variant [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
2878
- # @return [void]
2879
- # @overload set_property(name, variant)
2880
- # Sets a property by name and variant.
2881
- # @param name [String]
2882
- # @param variant [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue]
2883
- # @return [void]
2884
- # @overload set_property(name, value)
2885
- # Sets a property by name and string value.
2886
- # @param name [String]
2887
- # @param value [String]
2888
- # @return [void]
2889
- # @overload set_property(name, value)
2890
- # Sets property by name and long integer value.
2891
- # @param name [String]
2892
- # @param value [Integer]
2893
- # @return [void]
2894
- # @overload set_property(name, value)
2895
- # Sets property by name and double value.
2896
- # @param name [String]
2897
- # @param value [Float]
2898
- # @return [void]
2899
- # @overload set_property(name, value)
2900
- # Sets property by name and boolean value.
2901
- # @param name [String]
2902
- # @param value [Boolean]
2903
- # @return [void]
2904
- def set_property(*args) end
2905
- alias_method :property=, :set_property
2906
-
2907
- # Removes the given properties from these properties.
2908
- # @param properties [Wx::RTC::RichTextProperties]
2909
- # @return [void]
2910
- def remove_properties(properties) end
2911
-
2912
- # Merges the given properties with these properties.
2913
- # @param properties [Wx::RTC::RichTextProperties]
2914
- # @return [void]
2915
- def merge_properties(properties) end
2916
-
2917
- end # RichTextProperties
2918
-
2919
-
2920
- end
2921
-
2922
- end