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