Class: Wx::STC::StyledTextCtrl

Inherits:
Control show all
Includes:
TextEntry
Defined in:
lib/wx/doc/gen/stc/styled_text_ctrl.rb,
lib/wx/doc/stc/styled_text_ctrl.rb

Overview

A wxWidgets implementation of the Scintilla source code editing component.

As well as features found in standard text editing components, Scintilla includes features especially useful when editing and debugging source code. These include support for syntax styling, error indicators, code completion and call tips. The selection margin can contain markers like those used in debuggers to indicate breakpoints and the current line. Styling choices are more open than with many editors, allowing the use of proportional fonts, bold and italics, multiple foreground and background colours and multiple fonts. StyledTextCtrl is a 1 to 1 mapping of “raw” scintilla interface, whose documentation can be found in the Scintilla website (www.scintilla.org/). Please see StyledTextEvent for the documentation of all event types you can use with StyledTextCtrl.

Index of the member groups

Links for quick access to the various categories of StyledTextCtrl functions:

  • Constructors and related methods

  • Text retrieval and modification

  • Searching and replacing

  • Overtype

  • Cut copy and paste

  • Error handling

  • Undo and Redo

  • Selection and information

  • Multiple Selection and Virtual Space

  • Scrolling and automatic scrolling

  • White space

  • Cursor

  • Mouse capture

  • Line endings

  • Words

  • Styling

  • Style definition

  • Caret selection and hotspot styles

  • Character representations

  • Margins

  • Annotations

  • Other settings

  • Brace highlighting

  • Tabs and Indentation Guides

  • Markers

  • Indicators

  • Autocompletion

  • User lists

  • Call tips

  • Keyboard commands

  • Key bindings

  • Popup edit menu

  • Macro recording

  • Printing

  • Direct access

  • Multiple views

  • Background loading and saving

  • Folding

  • Line wrapping

  • Zooming

  • Long lines

  • Lexer

  • Event related items

  • Deprecated items

  • Additional StyledTextCtrl methods

  • Raw variants

  • Text entry methods

  • Text area methods

Category: Scintilla Text Editor

See Also:

Requires:

  • USE_STC

Class Method Summary collapse

Instance Method Summary collapse

Methods included from TextEntry

#auto_complete, #auto_complete_directories, #auto_complete_file_names, #can_copy, #can_cut, #change_value, #force_upper, #get_hint, #get_margins, #get_range, #get_string_selection, #get_value, #is_empty, #set_hint, #set_insertion_point_end, #set_max_length, #set_value

Methods inherited from Control

#command, ellipsize, escape_mnemonics, #get_label, #get_label_text, #get_size_from_text, #get_size_from_text_size, remove_mnemonics, #set_label, #set_label_markup, #set_label_text

Methods inherited from Window

#accepts_focus, #accepts_focus_from_keyboard, #accepts_focus_recursively, #add_child, #adjust_for_layout_direction, #always_show_scrollbars, #begin_repositioning_children, #cache_best_size, #can_accept_focus, #can_accept_focus_from_keyboard, #can_scroll, #can_set_transparent, #capture_mouse, #center, #center_on_parent, #centre, #centre_on_parent, #clear_background, #client_to_screen, #client_to_window_size, #close, #convert_dialog_to_pixels, #convert_pixels_to_dialog, #destroy, #destroy_children, #disable, #disable_focus_from_keyboard, #do_prepare_update_window_ui, #do_update_window_ui, #drag_accept_files, #each_child, #enable, #enable_touch_events, #enable_visible_focus, #end_repositioning_children, find_focus, #find_window_by_id, find_window_by_id, #find_window_by_label, find_window_by_label, #find_window_by_name, find_window_by_name, #fit, #fit_inside, #freeze, #from_dip, from_dip, #from_phys, from_phys, #get_accelerator_table, #get_auto_layout, #get_background_colour, #get_background_style, #get_best_height, #get_best_size, #get_best_virtual_size, #get_best_width, #get_border, get_capture, #get_caret, #get_char_height, #get_char_width, #get_children, get_class_default_attributes, #get_client_area_origin, #get_client_rect, #get_client_size, #get_containing_sizer, #get_content_scale_factor, #get_cursor, #get_cursor_bundle, #get_default_attributes, #get_dpi, #get_dpi_scale_factor, #get_drop_target, #get_effective_min_size, #get_event_handler, #get_extra_style, #get_font, #get_foreground_colour, #get_grand_parent, #get_help_text, #get_help_text_at_point, #get_id, #get_label, #get_layout_direction, #get_max_client_size, #get_max_height, #get_max_size, #get_max_width, #get_min_client_size, #get_min_height, #get_min_size, #get_min_width, #get_name, #get_next_sibling, #get_parent, #get_popup_menu_selection_from_user, #get_position, #get_prev_sibling, #get_rect, #get_screen_position, #get_screen_rect, #get_scroll_pos, #get_scroll_range, #get_scroll_thumb, #get_size, #get_sizer, #get_text_extent, #get_theme_enabled, #get_tool_tip, #get_tool_tip_text, #get_update_client_rect, #get_update_region, #get_validator, #get_virtual_size, #get_window_border_size, #get_window_style, #get_window_style_flag, #get_window_variant, #handle_as_navigation_key, #handle_window_event, #has_capture, #has_extra_style, #has_flag, #has_focus, #has_multiple_pages, #has_scrollbar, #has_transparent_background, #hide, #hide_with_effect, #inform_first_direction, #inherit_attributes, #inherits_background_colour, #inherits_foreground_colour, #init_dialog, #invalidate_best_size, #is_being_deleted, #is_descendant, #is_double_buffered, #is_enabled, #is_exposed, #is_focusable, #is_frozen, #is_retained, #is_scrollbar_always_shown, #is_shown, #is_shown_on_screen, #is_this_enabled, #is_top_level, #is_transparent_background_supported, #layout, #locked, #lower_window, #move, #move_after_in_tab_order, #move_before_in_tab_order, #msw_disable_composited, #navigate, #navigate_in, new_control_id, #on_internal_idle, #paint, #paint_buffered, #pop_event_handler, #popup_menu, #post_size_event, #post_size_event_to_parent, #process_window_event, #process_window_event_locally, #push_event_handler, #raise_window, #refresh, #refresh_rect, #register_hot_key, #release_mouse, #remove_child, #remove_event_handler, #reparent, #screen_to_client, #scroll_lines, #scroll_pages, #scroll_window, #send_size_event, #send_size_event_to_parent, #set_accelerator_table, #set_auto_layout, #set_background_colour, #set_background_style, #set_can_focus, #set_caret, #set_client_size, #set_containing_sizer, #set_cursor, #set_cursor_bundle, #set_double_buffered, #set_drop_target, #set_event_handler, #set_extra_style, #set_focus, #set_focus_from_kbd, #set_font, #set_foreground_colour, #set_help_text, #set_id, #set_initial_size, #set_label, #set_layout_direction, #set_max_client_size, #set_max_size, #set_min_client_size, #set_min_size, #set_name, #set_next_handler, #set_own_background_colour, #set_own_font, #set_own_foreground_colour, #set_position, #set_previous_handler, #set_scroll_pos, #set_scrollbar, #set_size, #set_size_hints, #set_sizer, #set_sizer_and_fit, #set_theme_enabled, #set_tool_tip, #set_transparent, #set_validator, #set_virtual_size, #set_window_style, #set_window_style_flag, #set_window_variant, #should_inherit_colours, #show, #show_with_effect, #switch_sizer, #thaw, #to_dip, to_dip, #to_phys, to_phys, #toggle_window_style, #transfer_data_from_window, #transfer_data_to_window, #unregister_hot_key, unreserve_control_id, #unset_tool_tip, #update, #update_window_ui, #use_background_colour, #use_bg_col, #use_foreground_colour, #validate, #warp_pointer, #window_to_client_size

Methods inherited from EvtHandler

add_filter, #add_pending_event, #call_after, clear_filters, #connect, #delete_pending_events, #disconnect, #evt_activate, #evt_activate_app, #evt_aui_pane_activated, #evt_aui_pane_button, #evt_aui_pane_close, #evt_aui_pane_maximize, #evt_aui_pane_restore, #evt_aui_render, #evt_auinotebook_allow_dnd, #evt_auinotebook_begin_drag, #evt_auinotebook_bg_dclick, #evt_auinotebook_button, #evt_auinotebook_drag_done, #evt_auinotebook_drag_motion, #evt_auinotebook_end_drag, #evt_auinotebook_page_changed, #evt_auinotebook_page_changing, #evt_auinotebook_page_close, #evt_auinotebook_page_closed, #evt_auinotebook_tab_middle_down, #evt_auinotebook_tab_middle_up, #evt_auinotebook_tab_right_down, #evt_auinotebook_tab_right_up, #evt_auitoolbar_begin_drag, #evt_auitoolbar_middle_click, #evt_auitoolbar_overflow_click, #evt_auitoolbar_right_click, #evt_auitoolbar_tool_dropdown, #evt_button, #evt_calculate_layout, #evt_calendar, #evt_calendar_page_changed, #evt_calendar_sel_changed, #evt_calendar_week_clicked, #evt_calendar_weekday_clicked, #evt_char, #evt_char_hook, #evt_checkbox, #evt_checklistbox, #evt_child_focus, #evt_choice, #evt_choicebook_page_changed, #evt_choicebook_page_changing, #evt_close, #evt_collapsiblepane_changed, #evt_colourpicker_changed, #evt_colourpicker_current_changed, #evt_colourpicker_dialog_cancelled, #evt_combobox, #evt_combobox_closeup, #evt_combobox_dropdown, #evt_command, #evt_command_enter, #evt_command_kill_focus, #evt_command_left_click, #evt_command_left_dclick, #evt_command_range, #evt_command_right_click, #evt_command_scroll, #evt_command_scroll_bottom, #evt_command_scroll_changed, #evt_command_scroll_linedown, #evt_command_scroll_lineup, #evt_command_scroll_pagedown, #evt_command_scroll_pageup, #evt_command_scroll_thumbrelease, #evt_command_scroll_thumbtrack, #evt_command_scroll_top, #evt_command_set_focus, #evt_context_menu, #evt_date_changed, #evt_dialup_connected, #evt_dialup_disconnected, #evt_dirctrl_fileactivated, #evt_dirctrl_selectionchanged, #evt_dirpicker_changed, #evt_dpi_changed, #evt_drop_files, #evt_end_session, #evt_enter_window, #evt_erase_background, #evt_filectrl_fileactivated, #evt_filectrl_filterchanged, #evt_filectrl_folderchanged, #evt_filectrl_selectionchanged, #evt_filepicker_changed, #evt_find, #evt_find_close, #evt_find_next, #evt_find_replace, #evt_find_replace_all, #evt_fontpicker_changed, #evt_fullscreen, #evt_gesture_pan, #evt_gesture_rotate, #evt_gesture_zoom, #evt_grid_cell_changed, #evt_grid_cell_changing, #evt_grid_cell_left_click, #evt_grid_cell_left_dclick, #evt_grid_cell_right_click, #evt_grid_cell_right_dclick, #evt_grid_cmd_col_size, #evt_grid_cmd_editor_created, #evt_grid_cmd_range_selected, #evt_grid_cmd_range_selecting, #evt_grid_cmd_row_size, #evt_grid_col_auto_size, #evt_grid_col_label_size, #evt_grid_col_move, #evt_grid_col_size, #evt_grid_col_sort, #evt_grid_editor_created, #evt_grid_editor_hidden, #evt_grid_editor_shown, #evt_grid_label_left_click, #evt_grid_label_left_dclick, #evt_grid_label_right_click, #evt_grid_label_right_dclick, #evt_grid_range_selected, #evt_grid_range_selecting, #evt_grid_row_auto_size, #evt_grid_row_label_size, #evt_grid_row_move, #evt_grid_row_size, #evt_grid_select_cell, #evt_grid_tabbing, #evt_header_begin_reorder, #evt_header_begin_resize, #evt_header_click, #evt_header_dclick, #evt_header_dragging_cancelled, #evt_header_end_reorder, #evt_header_end_resize, #evt_header_middle_click, #evt_header_middle_dclick, #evt_header_resizing, #evt_header_right_click, #evt_header_right_dclick, #evt_header_separator_dclick, #evt_help, #evt_help_range, #evt_hibernate, #evt_hotkey, #evt_html_cell_clicked, #evt_html_cell_hover, #evt_html_link_clicked, #evt_hyperlink, #evt_iconize, #evt_idle, #evt_init_dialog, #evt_joy_button_down, #evt_joy_button_up, #evt_joy_move, #evt_joy_zmove, #evt_joystick_events, #evt_key_down, #evt_key_up, #evt_kill_focus, #evt_leave_window, #evt_left_dclick, #evt_left_down, #evt_left_up, #evt_list_begin_drag, #evt_list_begin_label_edit, #evt_list_begin_rdrag, #evt_list_cache_hint, #evt_list_col_begin_drag, #evt_list_col_click, #evt_list_col_dragging, #evt_list_col_end_drag, #evt_list_col_right_click, #evt_list_delete_all_items, #evt_list_delete_item, #evt_list_end_label_edit, #evt_list_insert_item, #evt_list_item_activated, #evt_list_item_checked, #evt_list_item_deselected, #evt_list_item_focused, #evt_list_item_middle_click, #evt_list_item_right_click, #evt_list_item_selected, #evt_list_item_unchecked, #evt_list_key_down, #evt_listbook_page_changed, #evt_listbook_page_changing, #evt_listbox, #evt_listbox_dclick, #evt_long_press, #evt_magnify, #evt_maximize, #evt_media_finished, #evt_media_loaded, #evt_media_pause, #evt_media_play, #evt_media_statechanged, #evt_media_stop, #evt_menu, #evt_menu_close, #evt_menu_highlight, #evt_menu_highlight_all, #evt_menu_open, #evt_menu_range, #evt_middle_dclick, #evt_middle_down, #evt_middle_up, #evt_motion, #evt_mouse_aux1_dclick, #evt_mouse_aux1_down, #evt_mouse_aux1_up, #evt_mouse_aux2_dclick, #evt_mouse_aux2_down, #evt_mouse_aux2_up, #evt_mouse_events, #evt_mousewheel, #evt_move, #evt_move_end, #evt_move_start, #evt_moving, #evt_navigation_key, #evt_notebook_page_changed, #evt_notebook_page_changing, #evt_paint, #evt_pg_changed, #evt_pg_changing, #evt_pg_col_begin_drag, #evt_pg_col_dragging, #evt_pg_col_end_drag, #evt_pg_double_click, #evt_pg_highlighted, #evt_pg_item_collapsed, #evt_pg_item_expanded, #evt_pg_label_edit_begin, #evt_pg_label_edit_ending, #evt_pg_page_changed, #evt_pg_right_click, #evt_pg_selected, #evt_press_and_tap, #evt_query_end_session, #evt_query_layout_info, #evt_radiobox, #evt_radiobutton, #evt_ribbonbar_help_click, #evt_ribbonbar_page_changed, #evt_ribbonbar_page_changing, #evt_ribbonbar_tab_left_dclick, #evt_ribbonbar_tab_middle_down, #evt_ribbonbar_tab_middle_up, #evt_ribbonbar_tab_right_down, #evt_ribbonbar_tab_right_up, #evt_ribbonbar_toggled, #evt_ribbonbuttonbar_clicked, #evt_ribbonbuttonbar_dropdown_clicked, #evt_ribbongallery_clicked, #evt_ribbongallery_hover_changed, #evt_ribbongallery_selected, #evt_ribbonpanel_extbutton_activated, #evt_ribbontoolbar_clicked, #evt_ribbontoolbar_dropdown_clicked, #evt_richtext_buffer_reset, #evt_richtext_character, #evt_richtext_consuming_character, #evt_richtext_content_deleted, #evt_richtext_content_inserted, #evt_richtext_delete, #evt_richtext_focus_object_changed, #evt_richtext_left_click, #evt_richtext_left_dclick, #evt_richtext_middle_click, #evt_richtext_properties_changed, #evt_richtext_return, #evt_richtext_right_click, #evt_richtext_selection_changed, #evt_richtext_style_changed, #evt_richtext_stylesheet_changed, #evt_richtext_stylesheet_replaced, #evt_richtext_stylesheet_replacing, #evt_right_dclick, #evt_right_down, #evt_right_up, #evt_sash_dragged, #evt_sash_dragged_range, #evt_scroll, #evt_scroll_bottom, #evt_scroll_changed, #evt_scroll_linedown, #evt_scroll_lineup, #evt_scroll_pagedown, #evt_scroll_pageup, #evt_scroll_thumbrelease, #evt_scroll_thumbtrack, #evt_scroll_top, #evt_scrollbar, #evt_scrollwin, #evt_scrollwin_bottom, #evt_scrollwin_linedown, #evt_scrollwin_lineup, #evt_scrollwin_pagedown, #evt_scrollwin_pageup, #evt_scrollwin_thumbrelease, #evt_scrollwin_thumbtrack, #evt_scrollwin_top, #evt_search, #evt_search_cancel, #evt_set_cursor, #evt_set_focus, #evt_show, #evt_size, #evt_slider, #evt_spin, #evt_spin_down, #evt_spin_up, #evt_spinctrl, #evt_spinctrldouble, #evt_splitter_dclick, #evt_splitter_sash_pos_changed, #evt_splitter_sash_pos_changing, #evt_splitter_sash_pos_resize, #evt_splitter_unsplit, #evt_stc_autocomp_cancelled, #evt_stc_autocomp_char_deleted, #evt_stc_autocomp_completed, #evt_stc_autocomp_selection, #evt_stc_autocomp_selection_change, #evt_stc_calltip_click, #evt_stc_change, #evt_stc_charadded, #evt_stc_clipboard_copy, #evt_stc_clipboard_paste, #evt_stc_do_drop, #evt_stc_doubleclick, #evt_stc_drag_over, #evt_stc_dwellend, #evt_stc_dwellstart, #evt_stc_hotspot_click, #evt_stc_hotspot_dclick, #evt_stc_hotspot_release_click, #evt_stc_indicator_click, #evt_stc_indicator_release, #evt_stc_macrorecord, #evt_stc_margin_right_click, #evt_stc_marginclick, #evt_stc_modified, #evt_stc_needshown, #evt_stc_painted, #evt_stc_romodifyattempt, #evt_stc_savepointleft, #evt_stc_savepointreached, #evt_stc_start_drag, #evt_stc_styleneeded, #evt_stc_updateui, #evt_stc_userlistselection, #evt_stc_zoom, #evt_sys_colour_changed, #evt_taskbar_click, #evt_taskbar_left_dclick, #evt_taskbar_left_down, #evt_taskbar_left_up, #evt_taskbar_move, #evt_taskbar_right_dclick, #evt_taskbar_right_down, #evt_taskbar_right_up, #evt_text, #evt_text_copy, #evt_text_cut, #evt_text_enter, #evt_text_maxlen, #evt_text_paste, #evt_text_url, #evt_time_changed, #evt_timer, #evt_togglebutton, #evt_tool, #evt_tool_dropdown, #evt_tool_enter, #evt_tool_range, #evt_tool_rclicked, #evt_tool_rclicked_range, #evt_toolbook_page_changed, #evt_toolbook_page_changing, #evt_tree_begin_drag, #evt_tree_begin_label_edit, #evt_tree_begin_rdrag, #evt_tree_delete_item, #evt_tree_end_drag, #evt_tree_end_label_edit, #evt_tree_get_info, #evt_tree_item_activated, #evt_tree_item_collapsed, #evt_tree_item_collapsing, #evt_tree_item_expanded, #evt_tree_item_expanding, #evt_tree_item_gettooltip, #evt_tree_item_menu, #evt_tree_item_middle_click, #evt_tree_item_right_click, #evt_tree_key_down, #evt_tree_sel_changed, #evt_tree_sel_changing, #evt_tree_set_info, #evt_tree_state_image_click, #evt_treebook_node_collapsed, #evt_treebook_node_expanded, #evt_treebook_page_changed, #evt_treebook_page_changing, #evt_two_finger_tap, #evt_update_ui, #evt_update_ui_range, #evt_window_create, #evt_window_destroy, #evt_wizard_before_page_changed, #evt_wizard_cancel, #evt_wizard_finished, #evt_wizard_help, #evt_wizard_page_changed, #evt_wizard_page_changing, #evt_wizard_page_shown, #get_client_object, #get_evt_handler_enabled, #get_next_handler, #get_previous_handler, #is_unlinked, #process_event, #process_event_locally, #process_pending_events, #queue_event, register_class, remove_filter, #safely_process_event, #set_client_object, #set_evt_handler_enabled, #set_next_handler, #try_after, #try_before, #unlink

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0, name = Wx::STC_NAME_STR) ⇒ Wx::STC::StyledTextCtrl #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0, name = Wx::STC_NAME_STR) {|win| ... } ⇒ Wx::STC::StyledTextCtrl #initialize ⇒ Wx::STC::StyledTextCtrl

Returns a new instance of StyledTextCtrl.

Overloads:

  • #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0, name = Wx::STC_NAME_STR) ⇒ Wx::STC::StyledTextCtrl

    Ctor.

    Parameters:

    • parent (Wx::Window)
    • id (Integer) (defaults to: Wx::StandardID::ID_ANY)
    • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
    • size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
    • style (Integer) (defaults to: 0)
    • name (String) (defaults to: Wx::STC_NAME_STR)
  • #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0, name = Wx::STC_NAME_STR) {|win| ... } ⇒ Wx::STC::StyledTextCtrl

    Ctor.

    Parameters:

    • parent (Wx::Window)
    • id (Integer) (defaults to: Wx::StandardID::ID_ANY)
    • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
    • size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
    • style (Integer) (defaults to: 0)
    • name (String) (defaults to: Wx::STC_NAME_STR)

    Yield Parameters:

  • #initialize ⇒ Wx::STC::StyledTextCtrl

    Default ctor.



102
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 102

def initialize(*args) end

Class Method Details

.get_library_version_info ⇒ Wx::VersionInfo

Returns the version of the Scintilla library used by this control.

Returns:



4439
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4439

def self.get_library_version_info; end

Instance Method Details

#add_selection(caret, anchor) ⇒ void

This method returns an undefined value.

Add a selection.

Parameters:

  • caret (Integer)
  • anchor (Integer) 


816
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 816

def add_selection(caret, anchor) end

#add_tab_stop(line, x) ⇒ void

This method returns an undefined value.

Add an explicit tab stop for a line.

Parameters:

  • line (Integer)
  • x (Integer) 


2495
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2495

def add_tab_stop(line, x) end

#add_text(text) ⇒ void

This method returns an undefined value.

Add text to the document at current position.

Parameters:

  • text (String) 


119
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 119

def add_text(text) end

#add_undo_action(token, flags) ⇒ void

This method returns an undefined value.

Add a container action to the undo stack.

The flags argument can be either 0 or Wx::STC::STC_UNDO_MAY_COALESCE.

Parameters:

  • token (Integer)
  • flags (Integer) 


466
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 466

def add_undo_action(token, flags) end

#allocate(bytes) ⇒ void

This method returns an undefined value.

Enlarge the document to a particular size of text bytes.

Parameters:

  • bytes (Integer) 


211
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 211

def allocate(bytes) end

#allocate_extended_styles(numberStyles) ⇒ Integer

Allocate some extended (>255) style numbers and return the start of the range.

Parameters:

  • numberStyles (Integer)

Returns:

  • (Integer) 


220
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 220

def allocate_extended_styles(numberStyles) end

#allocate_sub_styles(styleBase, numberStyles) ⇒ Integer

Allocate a set of sub styles for a particular base style, returning start of range.

Parameters:

  • styleBase (Integer)
  • numberStyles (Integer)

Returns:

  • (Integer) 


4006
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4006

def allocate_sub_styles(styleBase, numberStyles) end

#annotation_clear_all ⇒ void

This method returns an undefined value.

Clear the annotations from all lines.



2073
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2073

def annotation_clear_all; end

#annotation_clear_line(line) ⇒ void

This method returns an undefined value.

Clear annotations from the given line.

Parameters:

  • line (Integer) 


4235
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4235

def annotation_clear_line(line) end

#annotation_get_lines(line) ⇒ Integer

Get the number of annotation lines for a line.

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


2069
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2069

def annotation_get_lines(line) end

#annotation_get_style(line) ⇒ Integer

Get the style number for the annotations for a line.

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


2053
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2053

def annotation_get_style(line) end

#annotation_get_style_offset ⇒ Integer

Get the start of the range of style numbers used for annotations.

Returns:

  • (Integer) 


2095
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2095

def annotation_get_style_offset; end

#annotation_get_styles(line) ⇒ String

Get the annotation styles for a line.

Parameters:

  • line (Integer)

Returns:

  • (String) 


2064
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2064

def annotation_get_styles(line) end

#annotation_get_text(line) ⇒ String

Get the annotation text for a line.

Parameters:

  • line (Integer)

Returns:

  • (String) 


2042
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2042

def annotation_get_text(line) end

#annotation_get_visible ⇒ Integer

Get the visibility for the annotations for a view.

The return value will be one of the wxSTC_ANNOTATION_* constants.

Returns:

  • (Integer) 


2086
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2086

def annotation_get_visible; end

#annotation_set_style(line, style) ⇒ void

This method returns an undefined value.

Set the style number for the annotations for a line.

Parameters:

  • line (Integer)
  • style (Integer) 


2048
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2048

def annotation_set_style(line, style) end

#annotation_set_style_offset(style) ⇒ void

This method returns an undefined value.

Get the start of the range of style numbers used for annotations.

Parameters:

  • style (Integer) 


2091
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2091

def annotation_set_style_offset(style) end

#annotation_set_styles(line, styles) ⇒ void

This method returns an undefined value.

Set the annotation styles for a line.

Parameters:

  • line (Integer)
  • styles (String) 


2059
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2059

def annotation_set_styles(line, styles) end

#annotation_set_text(line, text) ⇒ void

This method returns an undefined value.

Set the annotation text for a line.

Parameters:

  • line (Integer)
  • text (String) 


2037
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2037

def annotation_set_text(line, text) end

#annotation_set_visible(visible) ⇒ void

This method returns an undefined value.

Set the visibility for the annotations for a view.

The input should be one of the wxSTC_ANNOTATION_* constants.

Parameters:

  • visible (Integer) 


2080
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2080

def annotation_set_visible(visible) end

#append_text(text) ⇒ void

This method returns an undefined value.

Append a string to the end of the document without changing the selection.

Parameters:

  • text (String) 


206
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 206

def append_text(text) end

#auto_comp_active ⇒ Boolean

Is there an auto-completion list visible?

Returns:

  • (Boolean) 


2875
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2875

def auto_comp_active; end

#auto_comp_cancel ⇒ void

This method returns an undefined value.

Remove the auto-completion list from the screen.



2871
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2871

def auto_comp_cancel; end

#auto_comp_complete ⇒ void

This method returns an undefined value.

User has selected an item so remove the list and insert the selection.



2883
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2883

def auto_comp_complete; end

#auto_comp_get_auto_hide ⇒ Boolean

Retrieve whether or not autocompletion is hidden automatically when nothing matches.

Returns:

  • (Boolean) 


2945
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2945

def auto_comp_get_auto_hide; end

#auto_comp_get_cancel_at_start ⇒ Boolean

Retrieve whether auto-completion cancelled by backspacing before start.

Returns:

  • (Boolean) 


2913
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2913

def auto_comp_get_cancel_at_start; end

#auto_comp_get_case_insensitive_behaviour ⇒ Integer

Get auto-completion case insensitive behaviour.

The return value will be one of the wxSTC_CASEINSENSITIVEBEHAVIOUR_* constants.

Returns:

  • (Integer) 


3018
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3018

def auto_comp_get_case_insensitive_behaviour; end

#auto_comp_get_choose_single ⇒ Boolean

Retrieve whether a single item auto-completion list automatically choose the item.

Returns:

  • (Boolean) 


2927
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2927

def auto_comp_get_choose_single; end

#auto_comp_get_current ⇒ Integer

Get currently selected item position in the auto-completion list.

Returns:

  • (Integer) 


3001
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3001

def auto_comp_get_current; end

#auto_comp_get_current_text ⇒ String

Get currently selected item text in the auto-completion list.

Returns:

  • (String) 


3005
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3005

def auto_comp_get_current_text; end

#auto_comp_get_drop_rest_of_word ⇒ Boolean

Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion.

Returns:

  • (Boolean) 


2954
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2954

def auto_comp_get_drop_rest_of_word; end

#auto_comp_get_ignore_case ⇒ Boolean

Retrieve state of ignore case flag.

Returns:

  • (Boolean) 


2936
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2936

def auto_comp_get_ignore_case; end

#auto_comp_get_max_height ⇒ Integer

Set the maximum height, in rows, of auto-completion and user lists.

Returns:

  • (Integer) 


2997
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2997

def auto_comp_get_max_height; end

#auto_comp_get_max_width ⇒ Integer

Get the maximum width, in characters, of auto-completion and user lists.

Returns:

  • (Integer) 


2986
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2986

def auto_comp_get_max_width; end

#auto_comp_get_multi ⇒ Integer

Retrieve the effect of autocompleting when there are multiple selections.

The return value will be one of the wxSTC_MULTIAUTOC_* constants.

Returns:

  • (Integer) 


3031
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3031

def auto_comp_get_multi; end

#auto_comp_get_order ⇒ Integer

Get the way autocompletion lists are ordered.

The return value will be one of the wxSTC_ORDER_* constants.

Returns:

  • (Integer) 


3044
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3044

def auto_comp_get_order; end

#auto_comp_get_separator ⇒ Integer

Retrieve the auto-completion list separator character.

Returns:

  • (Integer) 


2899
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2899

def auto_comp_get_separator; end

#auto_comp_get_type_separator ⇒ Integer

Retrieve the auto-completion list type-separator character.

Returns:

  • (Integer) 


2968
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2968

def auto_comp_get_type_separator; end

#auto_comp_pos_start ⇒ Integer

Retrieve the position of the caret when the auto-completion list was displayed.

Returns:

  • (Integer) 


2879
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2879

def auto_comp_pos_start; end

#auto_comp_select(select) ⇒ void

This method returns an undefined value.

Select the item in the auto-completion list that starts with a string.

Parameters:

  • select (String) 


2904
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2904

def auto_comp_select(select) end

#auto_comp_set_auto_hide(autoHide) ⇒ void

This method returns an undefined value.

Set whether or not autocompletion is hidden automatically when nothing matches.

Parameters:

  • autoHide (Boolean) 


2941
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2941

def auto_comp_set_auto_hide(autoHide) end

#auto_comp_set_cancel_at_start(cancel) ⇒ void

This method returns an undefined value.

Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created.

Parameters:

  • cancel (Boolean) 


2909
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2909

def auto_comp_set_cancel_at_start(cancel) end

#auto_comp_set_case_insensitive_behaviour(behaviour) ⇒ void

This method returns an undefined value.

Set auto-completion case insensitive behaviour to either prefer case-sensitive matches or have no preference.

The input should be one of the wxSTC_CASEINSENSITIVEBEHAVIOUR_* constants.

Parameters:

  • behaviour (Integer) 


3012
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3012

def auto_comp_set_case_insensitive_behaviour(behaviour) end

#auto_comp_set_choose_single(chooseSingle) ⇒ void

This method returns an undefined value.

Should a single item auto-completion list automatically choose the item.

Parameters:

  • chooseSingle (Boolean) 


2923
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2923

def auto_comp_set_choose_single(chooseSingle) end

#auto_comp_set_drop_rest_of_word(dropRestOfWord) ⇒ void

This method returns an undefined value.

Set whether or not autocompletion deletes any word characters after the inserted text upon completion.

Parameters:

  • dropRestOfWord (Boolean) 


2950
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2950

def auto_comp_set_drop_rest_of_word(dropRestOfWord) end

#auto_comp_set_fill_ups(characterSet) ⇒ void

This method returns an undefined value.

Define a set of characters that when typed will cause the autocompletion to choose the selected item.

Parameters:

  • characterSet (String) 


2918
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2918

def auto_comp_set_fill_ups(characterSet) end

#auto_comp_set_ignore_case(ignoreCase) ⇒ void

This method returns an undefined value.

Set whether case is significant when performing auto-completion searches.

Parameters:

  • ignoreCase (Boolean) 


2932
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2932

def auto_comp_set_ignore_case(ignoreCase) end

#auto_comp_set_max_height(rowCount) ⇒ void

This method returns an undefined value.

Set the maximum height, in rows, of auto-completion and user lists.

The default is 5 rows.

Parameters:

  • rowCount (Integer) 


2993
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2993

def auto_comp_set_max_height(rowCount) end

#auto_comp_set_max_width(characterCount) ⇒ void

This method returns an undefined value.

Set the maximum width, in characters, of auto-completion and user lists.

Set to 0 to autosize to fit longest item, which is the default.

Parameters:

  • characterCount (Integer) 


2982
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2982

def auto_comp_set_max_width(characterCount) end

#auto_comp_set_multi(multi) ⇒ void

This method returns an undefined value.

Change the effect of autocompleting when there are multiple selections.

The input should be one of the wxSTC_MULTIAUTOC_* constants.

Parameters:

  • multi (Integer) 


3025
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3025

def auto_comp_set_multi(multi) end

#auto_comp_set_order(order) ⇒ void

This method returns an undefined value.

Set the way autocompletion lists are ordered.

The input should be one of the wxSTC_ORDER_* constants.

Parameters:

  • order (Integer) 


3038
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3038

def auto_comp_set_order(order) end

#auto_comp_set_separator(separatorCharacter) ⇒ void

This method returns an undefined value.

Change the separator character in the string setting up an auto-completion list.

Default is space but can be changed if items contain space.

Parameters:

  • separatorCharacter (Integer) 


2895
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2895

def auto_comp_set_separator(separatorCharacter) end

#auto_comp_set_type_separator(separatorCharacter) ⇒ void

This method returns an undefined value.

Change the type-separator character in the string setting up an auto-completion list.

Default is ‘?’ but can be changed if items contain ‘?’.

Parameters:

  • separatorCharacter (Integer) 


2975
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2975

def auto_comp_set_type_separator(separatorCharacter) end

#auto_comp_show(lengthEntered, itemList) ⇒ void

This method returns an undefined value.

Display a auto-completion list.

The lengthEntered parameter indicates how many characters before the caret should be used to provide context.

Parameters:

  • lengthEntered (Integer)
  • itemList (String) 


2867
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2867

def auto_comp_show(lengthEntered, itemList) end

#auto_comp_stops(characterSet) ⇒ void

This method returns an undefined value.

Define a set of character that when typed cancel the auto-completion list.

Parameters:

  • characterSet (String) 


2888
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2888

def auto_comp_stops(characterSet) end

#back_tab ⇒ void

This method returns an undefined value.

Dedent the selected lines.



3222
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3222

def back_tab; end

#begin_undo_action ⇒ void

This method returns an undefined value.

Start a sequence of actions that is undone and redone as a unit.

May be nested.



441
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 441

def begin_undo_action; end

#brace_bad_light(pos) ⇒ void

This method returns an undefined value.

Highlight the character at a position indicating there is no matching brace.

Parameters:

  • pos (Integer) 


2459
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2459

def brace_bad_light(pos) end

#brace_bad_light_indicator(useSetting, indicator) ⇒ void

This method returns an undefined value.

Use specified indicator to highlight non matching brace instead of changing its style.

Parameters:

  • useSetting (Boolean)
  • indicator (Integer) 


2465
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2465

def brace_bad_light_indicator(useSetting, indicator) end

#brace_highlight(posA, posB) ⇒ void

This method returns an undefined value.

Highlight the characters at two positions.

Parameters:

  • posA (Integer)
  • posB (Integer) 


2448
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2448

def brace_highlight(posA, posB) end

#brace_highlight_indicator(useSetting, indicator) ⇒ void

This method returns an undefined value.

Use specified indicator to highlight matching braces instead of changing their style.

Parameters:

  • useSetting (Boolean)
  • indicator (Integer) 


2454
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2454

def brace_highlight_indicator(useSetting, indicator) end

#brace_match(pos, maxReStyle = 0) ⇒ Integer

Find the position of a matching brace or Wx::STC::STC_INVALID_POSITION if no match.

The maxReStyle must be 0 for now. It may be defined in a future release.

Parameters:

  • pos (Integer)
  • maxReStyle (Integer) (defaults to: 0)

Returns:

  • (Integer) 


2473
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2473

def brace_match(pos, maxReStyle=0) end

#brace_match_next(pos, startPos) ⇒ Integer

Similar to BraceMatch, but matching starts at the explicit start position.

Parameters:

  • pos (Integer)
  • startPos (Integer)

Returns:

  • (Integer) 


2289
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2289

def brace_match_next(pos, startPos) end

#call_tip_active ⇒ Boolean

Is there an active call tip?

Returns:

  • (Boolean) 


3064
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3064

def call_tip_active; end

#call_tip_cancel ⇒ void

This method returns an undefined value.

Remove the call tip from the screen.



3060
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3060

def call_tip_cancel; end

#call_tip_pos_at_start ⇒ Integer

Retrieve the position where the caret was before displaying the call tip.

Returns:

  • (Integer) 


3068
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3068

def call_tip_pos_at_start; end

#call_tip_set_background(back) ⇒ void

This method returns an undefined value.

Set the background colour for the call tip.

Parameters:



3084
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3084

def call_tip_set_background(back) end

#call_tip_set_foreground(fore) ⇒ void

This method returns an undefined value.

Set the foreground colour for the call tip.

Parameters:



3089
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3089

def call_tip_set_foreground(fore) end

#call_tip_set_foreground_highlight(fore) ⇒ void

This method returns an undefined value.

Set the foreground colour for the highlighted part of the call tip.

Parameters:



3094
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3094

def call_tip_set_foreground_highlight(fore) end

#call_tip_set_highlight(highlightStart, highlightEnd) ⇒ void

This method returns an undefined value.

Highlight a segment of the definition.

Parameters:

  • highlightStart (Integer)
  • highlightEnd (Integer) 


3079
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3079

def call_tip_set_highlight(highlightStart, highlightEnd) end

#call_tip_set_pos_at_start(posStart) ⇒ void

This method returns an undefined value.

Set the start position in order to change when backspacing removes the calltip.

Parameters:

  • posStart (Integer) 


3073
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3073

def call_tip_set_pos_at_start(posStart) end

#call_tip_set_position(above) ⇒ void

This method returns an undefined value.

Set position of calltip, above or below text.

Parameters:

  • above (Boolean) 


3104
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3104

def call_tip_set_position(above) end

#call_tip_show(pos, definition) ⇒ void

This method returns an undefined value.

Show a call tip containing a definition near position pos.

Parameters:

  • pos (Integer)
  • definition (String) 


3056
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3056

def call_tip_show(pos, definition) end

#call_tip_use_style(tabSize) ⇒ void

This method returns an undefined value.

Enable use of Wx::STC::STC_STYLE_CALLTIP and set call tip tab size in pixels.

Parameters:

  • tabSize (Integer) 


3099
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3099

def call_tip_use_style(tabSize) end

#can_paste ⇒ Boolean Also known as: can_paste?

Will a paste succeed?

Returns:

  • (Boolean) 


354
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 354

def can_paste; end

#can_redo ⇒ Boolean Also known as: can_redo?

Are there any redoable actions in the undo history?

Returns:

  • (Boolean) 


429
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 429

def can_redo; end

#can_undo ⇒ Boolean Also known as: can_undo?

Are there any undoable actions in the undo history?

Returns:

  • (Boolean) 


449
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 449

def can_undo; end

#cancel ⇒ void

This method returns an undefined value.

Cancel any modes such as call tip or auto-completion list display.



3208
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3208

def cancel; end

#change_insertion(length, text) ⇒ void

This method returns an undefined value.

Change the text that is being inserted in response to Wx::STC::STC_MOD_INSERTCHECK.

Parameters:

  • length (Integer)
  • text (String) 


131
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 131

def change_insertion(length, text) end

#change_lexer_state(start, end_) ⇒ Integer

Indicate that the internal state of a lexer has changed over a range and therefore there may be a need to redraw.

Parameters:

  • start (Integer)
  • end_ (Integer)

Returns:

  • (Integer) 


3912
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3912

def change_lexer_state(start, end_) end

#char_left ⇒ void

This method returns an undefined value.

Move caret left one character.



3124
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3124

def char_left; end

#char_left_extend ⇒ void

This method returns an undefined value.

Move caret left one character extending selection to new caret position.



3128
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3128

def char_left_extend; end

#char_left_rect_extend ⇒ void

This method returns an undefined value.

Move caret left one character, extending rectangular selection to new caret position.



3386
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3386

def char_left_rect_extend; end

#char_position_from_point(x, y) ⇒ Integer

Find the position of a character from a point within the window.

Parameters:

  • x (Integer)
  • y (Integer)

Returns:

  • (Integer) 


710
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 710

def char_position_from_point(x, y) end

#char_position_from_point_close(x, y) ⇒ Integer

Find the position of a character from a point within the window.

Return Wx::STC::STC_INVALID_POSITION if not close to text.

Parameters:

  • x (Integer)
  • y (Integer)

Returns:

  • (Integer) 


718
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 718

def char_position_from_point_close(x, y) end

#char_right ⇒ void

This method returns an undefined value.

Move caret right one character.



3132
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3132

def char_right; end

#char_right_extend ⇒ void

This method returns an undefined value.

Move caret right one character extending selection to new caret position.



3136
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3136

def char_right_extend; end

#char_right_rect_extend ⇒ void

This method returns an undefined value.

Move caret right one character, extending rectangular selection to new caret position.



3390
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3390

def char_right_rect_extend; end

#choose_caret_x ⇒ void

This method returns an undefined value.

Set the last x chosen value to be the caret x position.



649
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 649

def choose_caret_x; end

#clear ⇒ void

This method returns an undefined value.

Clear the selection.



371
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 371

def clear; end

#clear_all ⇒ void

This method returns an undefined value.

Delete all text in the document.



135
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 135

def clear_all; end

#clear_document_style ⇒ void

This method returns an undefined value.

Set all style bytes to 0, remove all folding information.



145
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 145

def clear_document_style; end

#clear_registered_images ⇒ void

This method returns an undefined value.

Clear all the registered images.



2964
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2964

def clear_registered_images; end

#clear_representation(encodedCharacter) ⇒ void

This method returns an undefined value.

Remove a character representation.

Parameters:

  • encodedCharacter (String) 


1843
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1843

def clear_representation(encodedCharacter) end

#clear_selections ⇒ void

This method returns an undefined value.

Clear selections to a single empty stream selection.



810
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 810

def clear_selections; end

#clear_tab_stops(line) ⇒ void

This method returns an undefined value.

Clear explicit tabstops on a line.

Parameters:

  • line (Integer) 


2489
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2489

def clear_tab_stops(line) end

#cmd_key_assign(key, modifiers, cmd) ⇒ void

This method returns an undefined value.

When key+modifier combination keyDefinition is pressed perform sciCommand.

The second argument should be a bit list containing one or more of the wxSTC_KEYMOD* constants and the third argument should be one of the wxSTC_CMD* constants.

Parameters:

  • key (Integer)
  • modifiers (Integer)
  • cmd (Integer) 


3481
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3481

def cmd_key_assign(key, modifiers, cmd) end

#cmd_key_clear(key, modifiers) ⇒ void

This method returns an undefined value.

When key+modifier combination keyDefinition is pressed do nothing.

The second argument should be a bit list containing one or more of the wxSTC_KEYMOD_* constants.

Parameters:

  • key (Integer)
  • modifiers (Integer) 


3489
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3489

def cmd_key_clear(key, modifiers) end

#cmd_key_clear_all ⇒ void

This method returns an undefined value.

Drop all key mappings.



3493
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3493

def cmd_key_clear_all; end

#cmd_key_execute(cmd) ⇒ void

This method returns an undefined value.

Perform one of the operations defined by the Wx::STC_CMD_* constants.

Parameters:

  • cmd (Integer) 


4136
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4136

def cmd_key_execute(cmd) end

#colourise(start, end_) ⇒ void

This method returns an undefined value.

Colourise a segment of the document using the current lexing language.

Parameters:

  • start (Integer)
  • end_ (Integer) 


3933
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3933

def colourise(start, end_) end

#contracted_fold_next(lineStart) ⇒ Integer

Find the next line at or after lineStart that is a contracted fold header line.

Return -1 when no more lines.

Parameters:

  • lineStart (Integer)

Returns:

  • (Integer) 


3731
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3731

def contracted_fold_next(lineStart) end

#convert_eo_ls(eolMode) ⇒ void

This method returns an undefined value.

Convert all line endings in the document to one mode.

Parameters:

  • eolMode (Integer) 


1272
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1272

def convert_eo_ls(eolMode) end

#copy ⇒ void

This method returns an undefined value.

Copy the selection to the clipboard.



363
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 363

def copy; end

#copy_allow_line ⇒ void

This method returns an undefined value.

Copy the selection, if selection empty copy the line with the caret.



400
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 400

def copy_allow_line; end

#copy_range(start, end_) ⇒ void

This method returns an undefined value.

Copy a range of text to the clipboard.

Positions are clipped into the document.

Parameters:

  • start (Integer)
  • end_ (Integer) 


379
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 379

def copy_range(start, end_) end

#copy_text(length, text) ⇒ void

This method returns an undefined value.

Copy argument text to the clipboard.

Parameters:

  • length (Integer)
  • text (String) 


385
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 385

def copy_text(length, text) end

#count_characters(start, end_) ⇒ Integer

Count characters between two positions.

Parameters:

  • start (Integer)
  • end_ (Integer)

Returns:

  • (Integer) 


533
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 533

def count_characters(start, end_) end

#count_code_units(start, end_) ⇒ Integer

Count code units between two positions.

Parameters:

  • start (Integer)
  • end_ (Integer)

Returns:

  • (Integer) 


2182
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2182

def count_code_units(start, end_) end

#create(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = 0, name = Wx::STC_NAME_STR) ⇒ Boolean

Create the UI elements for a STC that was created with the default ctor.

(For 2-phase create.)

Parameters:

  • parent (Wx::Window)
  • id (Integer) (defaults to: Wx::StandardID::ID_ANY)
  • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
  • size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
  • style (Integer) (defaults to: 0)
  • name (String) (defaults to: Wx::STC_NAME_STR)

Returns:

  • (Boolean) 


114
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 114

def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STC_NAME_STR) end

#cut ⇒ void

This method returns an undefined value.

Cut the selection to the clipboard.



359
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 359

def cut; end

#del_line_left ⇒ void

This method returns an undefined value.

Delete back from the current position to the start of the line.



3354
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3354

def del_line_left; end

#del_line_right ⇒ void

This method returns an undefined value.

Delete forwards from the current position to the end of the line.



3358
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3358

def del_line_right; end

#del_word_left ⇒ void

This method returns an undefined value.

Delete the word to the left of the caret.



3244
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3244

def del_word_left; end

#del_word_right ⇒ void

This method returns an undefined value.

Delete the word to the right of the caret.



3248
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3248

def del_word_right; end

#del_word_right_end ⇒ void

This method returns an undefined value.

Delete the word to the right of the caret, but not the trailing non-word characters.



3252
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3252

def del_word_right_end; end

#delete_back ⇒ void

This method returns an undefined value.

Delete the selection or if no selection, the character before the caret.



3212
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3212

def delete_back; end

#delete_back_not_line ⇒ void

This method returns an undefined value.

Delete the selection or if no selection, the character before the caret.

Will not delete the character before at the start of a line.



3290
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3290

def delete_back_not_line; end

#delete_range(start, lengthDelete) ⇒ void

This method returns an undefined value.

Delete a range of text in the document.

Parameters:

  • start (Integer)
  • lengthDelete (Integer) 


141
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 141

def delete_range(start, lengthDelete) end

#describe_key_word_sets ⇒ String

Retrieve a ‘n’ separated list of descriptions of the keyword sets understood by the current lexer.

Returns:

  • (String) 


4000
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4000

def describe_key_word_sets; end

#describe_property(name) ⇒ String

Describe a property.

Parameters:

  • name (String)

Returns:

  • (String) 


3996
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3996

def describe_property(name) end

#description_of_style(style) ⇒ String

Retrieve a description of a style.

Result is NUL-terminated.

Parameters:

  • style (Integer)

Returns:

  • (String) 


2436
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2436

def description_of_style(style) end

#discard_edits ⇒ void

This method returns an undefined value.

Resets the internal modified flag as if the current changes had been saved.



4384
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4384

def discard_edits; end

#distance_to_secondary_styles ⇒ Integer

Where styles are duplicated by a feature such as active/inactive code return the distance between the two types.

Returns:

  • (Integer) 


4044
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4044

def distance_to_secondary_styles; end

#do_drag_enter(x, y, defaultRes) ⇒ Wx::DragResult

Allow for simulating a DnD DragEnter.

Parameters:

Returns:



4199
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4199

def do_drag_enter(x, y, defaultRes) end

#do_drag_leave ⇒ void

This method returns an undefined value.

Allow for simulating a DnD DragLeave.



4210
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4210

def do_drag_leave; end

#do_drag_over(x, y, defaultRes) ⇒ Wx::DragResult

Allow for simulating a DnD DragOver.

Parameters:

Returns:



4206
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4206

def do_drag_over(x, y, defaultRes) end

#do_drop_text(x, y, data) ⇒ Boolean

Allow for simulating a DnD DropText.

Parameters:

  • x (Integer)
  • y (Integer)
  • data (String)

Returns:

  • (Boolean) 


4217
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4217

def do_drop_text(x, y, data) end

#doc_line_from_visible(displayLine) ⇒ Integer

Find the document line of a display line taking hidden lines into account.

Parameters:

  • displayLine (Integer)

Returns:

  • (Integer) 


3578
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3578

def doc_line_from_visible(displayLine) end

#document_end ⇒ void

This method returns an undefined value.

Move caret to last position in document.



3180
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3180

def document_end; end

#document_end_extend ⇒ void

This method returns an undefined value.

Move caret to last position in document extending selection to new caret position.



3184
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3184

def document_end_extend; end

#document_start ⇒ void

This method returns an undefined value.

Move caret to first position in document.



3172
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3172

def document_start; end

#document_start_extend ⇒ void

This method returns an undefined value.

Move caret to first position in document extending selection to new caret position.



3176
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3176

def document_start_extend; end

#drop_selection_n(selection) ⇒ void

This method returns an undefined value.

Drop one selection.

Parameters:

  • selection (Integer) 


821
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 821

def drop_selection_n(selection) end

#each_line {|line| ... } ⇒ Object #each_line ⇒ Enumerator

Yield each line to the given block. Returns an Enumerator if no block given.

Overloads:

  • #each_line {|line| ... } ⇒ Object

    Returns last result of block.

    Yield Parameters:

    • line (String) —

      the line yielded

    Returns:

    • (Object) —

      last result of block

  • #each_line ⇒ Enumerator

    Returns enumerator.

    Returns:

    • (Enumerator) —

      enumerator



21
 
# File 'lib/wx/doc/stc/styled_text_ctrl.rb', line 21

def each_line(*) end

#edit_toggle_overtype ⇒ void

This method returns an undefined value.

Switch from insert to overtype mode or the reverse.



3204
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3204

def edit_toggle_overtype; end

#empty_undo_buffer ⇒ void

This method returns an undefined value.

Delete the undo history.



454
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 454

def empty_undo_buffer; end

#end_undo_action ⇒ void

This method returns an undefined value.

End a sequence of actions that is undone and redone as a unit.



445
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 445

def end_undo_action; end

#ensure_caret_visible ⇒ void

This method returns an undefined value.

Ensure the caret is visible.



1062
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1062

def ensure_caret_visible; end

#ensure_visible(line) ⇒ void

This method returns an undefined value.

Ensure a particular line is visible by expanding any header line hiding it.

Parameters:

  • line (Integer) 


3694
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3694

def ensure_visible(line) end

#ensure_visible_enforce_policy(line) ⇒ void

This method returns an undefined value.

Ensure a particular line is visible by expanding any header line hiding it.

Use the currently set visibility policy to determine which range to display.

Parameters:

  • line (Integer) 


3724
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3724

def ensure_visible_enforce_policy(line) end

#eol_annotation_clear_all ⇒ void

This method returns an undefined value.

Clear the end of annotations from all lines.



2392
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2392

def eol_annotation_clear_all; end

#eol_annotation_get_style(line) ⇒ Integer

Get the style number for the end of line annotations for a line.

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


2388
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2388

def eol_annotation_get_style(line) end

#eol_annotation_get_style_offset ⇒ Integer

Get the start of the range of style numbers used for end of line annotations.

Returns:

  • (Integer) 


2410
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2410

def eol_annotation_get_style_offset; end

#eol_annotation_get_text(line) ⇒ String

Get the end of line annotation text for a line.

Parameters:

  • line (Integer)

Returns:

  • (String) 


2377
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2377

def eol_annotation_get_text(line) end

#eol_annotation_get_visible ⇒ Integer

Get the visibility for the end of line annotations for a view.

Returns:

  • (Integer) 


2401
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2401

def eol_annotation_get_visible; end

#eol_annotation_set_style(line, style) ⇒ void

This method returns an undefined value.

Set the style number for the end of line annotations for a line.

Parameters:

  • line (Integer)
  • style (Integer) 


2383
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2383

def eol_annotation_set_style(line, style) end

#eol_annotation_set_style_offset(style) ⇒ void

This method returns an undefined value.

Get the start of the range of style numbers used for end of line annotations.

Parameters:

  • style (Integer) 


2406
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2406

def eol_annotation_set_style_offset(style) end

#eol_annotation_set_text(line, text) ⇒ void

This method returns an undefined value.

Set the end of line annotation text for a line.

Parameters:

  • line (Integer)
  • text (String) 


2372
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2372

def eol_annotation_set_text(line, text) end

#eol_annotation_set_visible(visible) ⇒ void

This method returns an undefined value.

Set the visibility for the end of line annotations for a view.

Parameters:

  • visible (Integer) 


2397
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2397

def eol_annotation_set_visible(visible) end

#expand_children(line, level) ⇒ void

This method returns an undefined value.

Expand a fold header and all children.

Use the level argument instead of the line’s current level.

Parameters:

  • line (Integer)
  • level (Integer) 


3682
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3682

def expand_children(line, level) end

#find_column(line, column) ⇒ Integer

Find the position of a column on a line taking into account tabs and multi-byte characters.

If beyond end of line, return line end position.

Parameters:

  • line (Integer)
  • column (Integer)

Returns:

  • (Integer) 


704
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 704

def find_column(line, column) end

#find_text(minPos, maxPos, text, flags = 0) ⇒ Array(Integer,Integer)

Find some text in the document.

The position (starting from zero) in the document at which the text was found or Wx::STC::STC_INVALID_POSITION if the search fails.

Remark:

A backwards search can be performed by setting minPos to be greater than maxPos.

Parameters:

  • minPos (Integer) —

    The position (starting from zero) in the document at which to begin the search

  • maxPos (Integer) —

    The last position (starting from zero) in the document to which the search will be restricted.

  • text (String) —

    The text to search for.

  • flags (Integer) (defaults to: 0) —

    (Optional) The search flags. This should be a bit list containing one or more of the wxSTC_FIND_* constants.

Returns:

  • (Array(Integer,Integer)) 


236
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 236

def find_text(minPos, maxPos, text, flags=0) end

#fold_all(action) ⇒ void

This method returns an undefined value.

Expand or contract all fold headers.

The input should be one of the wxSTC_FOLDACTION_* constants.

Parameters:

  • action (Integer) 


3689
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3689

def fold_all(action) end

#fold_children(line, action) ⇒ void

This method returns an undefined value.

Expand or contract a fold header and its children.

The second argument should be one of the wxSTC_FOLDACTION_* constants.

Parameters:

  • line (Integer)
  • action (Integer) 


3674
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3674

def fold_children(line, action) end

#fold_display_text_get_style ⇒ Integer

Get the style of fold display text.

Returns:

  • (Integer) 


2213
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2213

def fold_display_text_get_style; end

#fold_display_text_set_style(style) ⇒ void

This method returns an undefined value.

Set the style of fold display text.

The input should be one of the wxSTC_FOLDDISPLAYTEXT_* constants.

Parameters:

  • style (Integer) 


3658
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3658

def fold_display_text_set_style(style) end

#fold_line(line, action) ⇒ void

This method returns an undefined value.

Expand or contract a fold header.

The second argument should be one of the wxSTC_FOLDACTION_* constants.

Parameters:

  • line (Integer)
  • action (Integer) 


3666
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3666

def fold_line(line, action) end

#form_feed ⇒ void

This method returns an undefined value.

Insert a Form Feed character.



3230
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3230

def form_feed; end

#format_range(doDraw, startPos, endPos, draw, target, renderRect, pageRect) ⇒ Integer

On Windows, will draw the document into a display context such as a printer.

Parameters:

Returns:

  • (Integer) 


3550
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3550

def format_range(doDraw, startPos, endPos, draw, target, renderRect, pageRect) end

#free_sub_styles ⇒ void

This method returns an undefined value.

Free allocated sub styles.



4034
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4034

def free_sub_styles; end

#get_accessibility ⇒ Integer Also known as: accessibility

Report accessibility status.

Returns:

  • (Integer) 


2278
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2278

def get_accessibility; end

#get_additional_caret_foreground ⇒ Wx::Colour Also known as: additional_caret_foreground

Get the foreground colour of additional carets.

Returns:



1015
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1015

def get_additional_caret_foreground; end

#get_additional_carets_blink ⇒ Boolean Also known as: additional_carets_blink

Whether additional carets will blink.

Returns:

  • (Boolean) 


784
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 784

def get_additional_carets_blink; end

#get_additional_carets_visible ⇒ Boolean Also known as: additional_carets_visible

Whether additional carets are visible.

Returns:

  • (Boolean) 


795
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 795

def get_additional_carets_visible; end

#get_additional_sel_alpha ⇒ Integer Also known as: additional_sel_alpha

Get the alpha of the selection.

Returns:

  • (Integer) 


1004
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1004

def get_additional_sel_alpha; end

#get_additional_selection_typing ⇒ Boolean Also known as: additional_selection_typing

Whether typing can be performed into multiple selections.

Returns:

  • (Boolean) 


773
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 773

def get_additional_selection_typing; end

#get_all_lines_visible ⇒ Boolean Also known as: all_lines_visible

Are all lines visible?

Returns:

  • (Boolean) 


3627
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3627

def get_all_lines_visible; end

#get_anchor ⇒ Integer Also known as: anchor

Returns the position of the opposite end of the selection to the caret.

Returns:

  • (Integer) 


480
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 480

def get_anchor; end

#get_automatic_fold ⇒ Integer Also known as: automatic_fold

Get automatic folding behaviours.

The return value will be a bit list containing one or more of the wxSTC_AUTOMATICFOLD_* constants.

Returns:

  • (Integer) 


3708
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3708

def get_automatic_fold; end

#get_back_space_un_indents ⇒ Boolean Also known as: back_space_un_indents

Does a backspace pressed when caret is within indentation unindent?

Returns:

  • (Boolean) 


2591
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2591

def get_back_space_un_indents; end

#get_buffered_draw ⇒ Boolean Also known as: buffered_draw

Is drawing done first into a buffer or direct to the screen?

Returns:

  • (Boolean) 


2111
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2111

def get_buffered_draw; end

#get_caret_foreground ⇒ Wx::Colour Also known as: caret_foreground

Get the foreground colour of the caret.

Returns:



1703
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1703

def get_caret_foreground; end

#get_caret_line_back_alpha ⇒ Integer Also known as: caret_line_back_alpha

Get the background alpha of the caret line.

Returns:

  • (Integer) 


1788
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1788

def get_caret_line_back_alpha; end

#get_caret_line_background ⇒ Wx::Colour Also known as: caret_line_background

Get the colour of the background of the line containing the caret.

Returns:



1692
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1692

def get_caret_line_background; end

#get_caret_line_frame ⇒ Integer Also known as: caret_line_frame

Retrieve the caret line frame width.

Width = 0 means this option is disabled.

Returns:

  • (Integer) 


2167
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2167

def get_caret_line_frame; end

#get_caret_line_visible ⇒ Boolean Also known as: caret_line_visible

Is the background of the line containing the caret in a different colour?

Returns:

  • (Boolean) 


1681
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1681

def get_caret_line_visible; end

#get_caret_line_visible_always ⇒ Boolean Also known as: caret_line_visible_always

Is the caret line always visible?

Returns:

  • (Boolean) 


1808
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1808

def get_caret_line_visible_always; end

#get_caret_period ⇒ Integer Also known as: caret_period

Get the time in milliseconds that the caret is on and off.

Returns:

  • (Integer) 


1668
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1668

def get_caret_period; end

#get_caret_sticky ⇒ Integer Also known as: caret_sticky

Can the caret preferred x position only be changed by explicit movement commands?

The return value will be one of the wxSTC_CARETSTICKY_* constants.

Returns:

  • (Integer) 


1765
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1765

def get_caret_sticky; end

#get_caret_style ⇒ Integer Also known as: caret_style

Returns the current style of the caret.

The return value will be one of the wxSTC_CARETSTYLE_* constants.

Returns:

  • (Integer) 


1803
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1803

def get_caret_style; end

#get_caret_width ⇒ Integer Also known as: caret_width

Returns the width of the insert mode caret.

Returns:

  • (Integer) 


1714
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1714

def get_caret_width; end

#get_char_at(pos) ⇒ Integer Also known as: char_at

Returns the character byte at the position.

Parameters:

  • pos (Integer)

Returns:

  • (Integer) 


150
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 150

def get_char_at(pos) end

#get_character_category_optimization ⇒ Integer Also known as: character_category_optimization

Get the number of characters to have directly indexed categories.

Returns:

  • (Integer) 


2160
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2160

def get_character_category_optimization; end

#get_code_page ⇒ Integer Also known as: code_page

Get the code page used to interpret the bytes of the document as characters.

Returns:

  • (Integer) 


2186
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2186

def get_code_page; end

#get_column(pos) ⇒ Integer Also known as: column

Retrieve the column number of a position, taking tab width into account.

Parameters:

  • pos (Integer)

Returns:

  • (Integer) 


526
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 526

def get_column(pos) end

#get_command_events ⇒ Boolean Also known as: command_events

Get whether command events are sent to the container.

Returns:

  • (Boolean) 


2310
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2310

def get_command_events; end

#get_control_char_symbol ⇒ Integer Also known as: control_char_symbol

Get the way control characters are displayed.

Returns:

  • (Integer) 


1825
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1825

def get_control_char_symbol; end

#get_cur_line ⇒ Array(String,Integer) Also known as: cur_line

Retrieve the text of the line containing the caret.

linePos can optionally be passed in to receive the index of the caret on the line.

Returns:

  • (Array(String,Integer)) 


520
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 520

def get_cur_line; end

#get_current_line ⇒ Integer Also known as: current_line

Returns the line number of the line with the caret.

Returns:

  • (Integer) 


4094
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4094

def get_current_line; end

#get_current_pos ⇒ Integer Also known as: current_pos

Returns the position of the caret.

Returns:

  • (Integer) 


475
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 475

def get_current_pos; end

#get_default_fold_display_text ⇒ String Also known as: default_fold_display_text

Get the default fold display text.

Returns:

  • (String) 


2223
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2223

def get_default_fold_display_text; end

#get_document_options ⇒ Integer Also known as: document_options

Get which document options are set.

Returns:

  • (Integer) 


2299
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2299

def get_document_options; end

#get_edge_colour ⇒ Wx::Colour Also known as: edge_colour

Retrieve the colour used in edge indication.

Returns:



3889
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3889

def get_edge_colour; end

#get_edge_column ⇒ Integer Also known as: edge_column

Retrieve the column number which text should be kept within.

Returns:

  • (Integer) 


3861
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3861

def get_edge_column; end

#get_edge_mode ⇒ Integer Also known as: edge_mode

Retrieve the edge highlight mode.

The return value will be one of the wxSTC_EDGE_* constants.

Returns:

  • (Integer) 


3876
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3876

def get_edge_mode; end

#get_end_at_last_line ⇒ Boolean Also known as: end_at_last_line

Retrieve whether the maximum scroll position has the last line at the bottom of the view.

Returns:

  • (Boolean) 


1104
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1104

def get_end_at_last_line; end

#get_end_styled ⇒ Integer Also known as: end_styled

Retrieve the position of the last correctly styled character.

Returns:

  • (Integer) 


1391
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1391

def get_end_styled; end

#get_eol_mode ⇒ Integer Also known as: eol_mode

Retrieve the current end of line mode - one of Wx::STC::STC_EOL_CRLF, Wx::STC::STC_EOL_CR, or Wx::STC::STC_EOL_LF.

Returns:

  • (Integer) 


1276
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1276

def get_eol_mode; end

#get_extra_ascent ⇒ Integer Also known as: extra_ascent

Get extra ascent for each line.

Returns:

  • (Integer) 


1220
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1220

def get_extra_ascent; end

#get_extra_descent ⇒ Integer Also known as: extra_descent

Get extra descent for each line.

Returns:

  • (Integer) 


1231
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1231

def get_extra_descent; end

#get_first_visible_line ⇒ Integer Also known as: first_visible_line

Retrieve the display line at the top of the display.

Returns:

  • (Integer) 


1051
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1051

def get_first_visible_line; end

#get_fold_expanded(line) ⇒ Boolean Also known as: fold_expanded

Is a header line expanded?

Parameters:

  • line (Integer)

Returns:

  • (Boolean) 


3639
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3639

def get_fold_expanded(line) end

#get_fold_level(line) ⇒ Integer Also known as: fold_level

Retrieve the fold level of a line.

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


3591
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3591

def get_fold_level(line) end

#get_fold_parent(line) ⇒ Integer Also known as: fold_parent

Find the parent line of a child line.

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


3604
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3604

def get_fold_parent(line) end

#get_font_quality ⇒ Integer Also known as: font_quality

Retrieve the quality level for text.

The return value will be one of the wxSTC_EFF_QUALITY_* constants.

Returns:

  • (Integer) 


2267
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2267

def get_font_quality; end

#get_gap_position ⇒ Integer Also known as: gap_position

Return a position which, to avoid performance costs, should not be within the range of a call to GetRangePointer.

Returns:

  • (Integer) 


3567
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3567

def get_gap_position; end

#get_highlight_guide ⇒ Integer Also known as: highlight_guide

Get the highlighted indentation guide column.

Returns:

  • (Integer) 


2569
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2569

def get_highlight_guide; end

#get_hotspot_active_background ⇒ Wx::Colour Also known as: hotspot_active_background

Get the back colour for active hotspots.

Returns:



1736
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1736

def get_hotspot_active_background; end

#get_hotspot_active_foreground ⇒ Wx::Colour Also known as: hotspot_active_foreground

Get the fore colour for active hotspots.

Returns:



1725
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1725

def get_hotspot_active_foreground; end

#get_hotspot_active_underline ⇒ Boolean Also known as: hotspot_active_underline

Get whether underlining for active hotspots.

Returns:

  • (Boolean) 


1747
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1747

def get_hotspot_active_underline; end

#get_hotspot_single_line ⇒ Boolean Also known as: hotspot_single_line

Get the HotspotSingleLine property.

Returns:

  • (Boolean) 


1758
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1758

def get_hotspot_single_line; end

#get_identifier ⇒ Integer Also known as: identifier

Get the identifier.

Returns:

  • (Integer) 


4089
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4089

def get_identifier; end

#get_idle_styling ⇒ Integer Also known as: idle_styling

Retrieve the limits to idle styling.

The return value will be one of the wxSTC_IDLESTYLING_* constants.

Returns:

  • (Integer) 


1434
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1434

def get_idle_styling; end

#get_ime_interaction ⇒ Integer Also known as: ime_interaction

Is the IME displayed in a window or inline?

The return value will be one of the wxSTC_IME_* constants.

Returns:

  • (Integer) 


2141
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2141

def get_ime_interaction; end

#get_indent ⇒ Integer Also known as: indent

Retrieve indentation size.

Returns:

  • (Integer) 


2512
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2512

def get_indent; end

#get_indentation_guides ⇒ Integer Also known as: indentation_guides

Are the indentation guides visible?

The return value will be one of the wxSTC_IV_* constants.

Returns:

  • (Integer) 


2556
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2556

def get_indentation_guides; end

#get_indicator_current ⇒ Integer Also known as: indicator_current

Get the current indicator.

Returns:

  • (Integer) 


2790
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2790

def get_indicator_current; end

#get_indicator_value ⇒ Integer Also known as: indicator_value

Get the current indicator value.

Returns:

  • (Integer) 


2801
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2801

def get_indicator_value; end

#get_insertion_point ⇒ Integer Also known as: insertion_point

Returns the insertion point, or cursor, position.

This is defined as the zero based index of the character position to the right of the insertion point. For example, if the insertion point is at the end of the single-line text control, it is equal to #get_last_position. Notice that insertion position is, in general, different from the index of the character the cursor position at in the string returned by TextEntry#get_value. While this is always the case for the single line controls, multi-line controls can use two characters "\r\n" as line separator (this is notably the case under MSW) meaning that indices in the control and its string value are offset by 1 for every line. Hence to correctly get the character at the current cursor position, taking into account that there can be none if the cursor is at the end of the string, you could do the following:

def get_current_char(tc)
    pos = tc.insertion_point
    if pos == tc.last_position
      nil
    else
      tc.get_range(pos, pos + 1)
    end
  end

Returns:

  • (Integer) 


4294
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4294

def get_insertion_point; end

#get_last_child(line, level) ⇒ Integer Also known as: last_child

Find the last child line of a header line.

Parameters:

  • line (Integer)
  • level (Integer)

Returns:

  • (Integer) 


3598
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3598

def get_last_child(line, level) end

#get_last_keydown_processed ⇒ Boolean Also known as: last_keydown_processed

Can be used to prevent the EVT_CHAR handler from adding the char.

Returns:

  • (Boolean) 


4175
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4175

def get_last_keydown_processed; end

#get_last_position ⇒ Integer Also known as: last_position

Returns the zero based index of the last position in the text control, which is equal to the number of characters in the control.

Returns:

  • (Integer) 


4299
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4299

def get_last_position; end

#get_layout_cache ⇒ Integer Also known as: layout_cache

Retrieve the degree of caching of layout information.

The return value will be one of the wxSTC_CACHE_* constants.

Returns:

  • (Integer) 


3815
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3815

def get_layout_cache; end

#get_length ⇒ Integer Also known as: length

Returns the number of bytes in the document.

Returns:

  • (Integer) 


470
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 470

def get_length; end

#get_lexer ⇒ Integer Also known as: lexer

Retrieve the lexing language of the document.

The return value will be one of the wxSTC_LEX_* constants.

Returns:

  • (Integer) 


3926
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3926

def get_lexer; end

#get_lexer_language ⇒ String Also known as: lexer_language

Retrieve the lexing language of the document.

Returns:

  • (String) 


3979
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3979

def get_lexer_language; end

#get_line(line) ⇒ String Also known as: line

Retrieve the contents of a line.

Parameters:

  • line (Integer)

Returns:

  • (String) 


171
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 171

def get_line(line) end

#get_line_count ⇒ Integer Also known as: line_count

Returns the number of lines in the document.

There is always at least one.

Returns:

  • (Integer) 


579
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 579

def get_line_count; end

#get_line_end_position(line) ⇒ Integer Also known as: line_end_position

Get the position after the last visible characters on a line.

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


538
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 538

def get_line_end_position(line) end

#get_line_end_types_active ⇒ Integer Also known as: line_end_types_active

Get the line end types currently recognised.

May be a subset of the allowed types due to lexer limitation. The return value will be one of the wxSTC_LINE_END_TYPE_* constants.

Returns:

  • (Integer) 


1319
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1319

def get_line_end_types_active; end

#get_line_end_types_allowed ⇒ Integer Also known as: line_end_types_allowed

Get the line end types currently allowed.

The return value will be one of the wxSTC_LINE_END_TYPE_* constants.

Returns:

  • (Integer) 


1311
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1311

def get_line_end_types_allowed; end

#get_line_end_types_supported ⇒ Integer Also known as: line_end_types_supported

Bit set of LineEndType enumertion for which line ends beyond the standard LF, CR, and CRLF are supported by the lexer.

The return value will be a bit list containing one or more of the wxSTC_LINE_END_TYPE_* constants.

Returns:

  • (Integer) 


1326
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1326

def get_line_end_types_supported; end

#get_line_indent_position(line) ⇒ Integer Also known as: line_indent_position

Retrieve the position before the first non indentation character on a line.

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


2541
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2541

def get_line_indent_position(line) end

#get_line_indentation(line) ⇒ Integer Also known as: line_indentation

Retrieve the number of columns that a line is indented.

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


2535
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2535

def get_line_indentation(line) end

#get_line_length(lineNo) ⇒ Integer

Gets the length of the specified line, not including any trailing newline character(s).

The length of the line, or -1 if lineNo was invalid.

Parameters:

  • lineNo (Integer) —

    Line number (starting from zero).

Returns:

  • (Integer) 


4344
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4344

def get_line_length(lineNo) end

#get_line_sel_end_position(line) ⇒ Integer Also known as: line_sel_end_position

Retrieve the position of the end of the selection at the given line (Wx::STC::STC_INVALID_POSITION if no selection on this line).

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


695
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 695

def get_line_sel_end_position(line) end

#get_line_sel_start_position(line) ⇒ Integer Also known as: line_sel_start_position

Retrieve the position of the start of the selection at the given line (Wx::STC::STC_INVALID_POSITION if no selection on this line).

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


689
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 689

def get_line_sel_start_position(line) end

#get_line_state(line) ⇒ Integer Also known as: line_state

Retrieve the extra styling information for a line.

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


1414
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1414

def get_line_state(line) end

#get_line_text(lineNo) ⇒ String Also known as: line_text

Returns the contents of a given line in the text control, not including any trailing newline character(s).

The contents of the line.

Parameters:

  • lineNo (Integer) —

    The line number, starting from zero.

Returns:

  • (String) 


4351
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4351

def get_line_text(lineNo) end

#get_line_visible(line) ⇒ Boolean Also known as: line_visible

Is a line visible?

Parameters:

  • line (Integer)

Returns:

  • (Boolean) 


3622
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3622

def get_line_visible(line) end

#get_main_selection ⇒ Integer Also known as: main_selection

Which selection is the main selection.

Returns:

  • (Integer) 


831
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 831

def get_main_selection; end

#get_margin_background(margin) ⇒ Wx::Colour Also known as: margin_background

Retrieve the background colour of a margin.

Parameters:

  • margin (Integer)

Returns:



1924
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1924

def get_margin_background(margin) end

#get_margin_count ⇒ Integer Also known as: margin_count

How many margins are there?.

Returns:

  • (Integer) 


1935
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1935

def get_margin_count; end

#get_margin_cursor(margin) ⇒ Integer Also known as: margin_cursor

Retrieve the cursor shown in a margin.

The return value will be one of the wxSTC_CURSOR* constants.

Parameters:

  • margin (Integer)

Returns:

  • (Integer) 


1910
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1910

def get_margin_cursor(margin) end

#get_margin_left ⇒ Integer Also known as: margin_left

Returns the size in pixels of the left margin.

Returns:

  • (Integer) 


1946
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1946

def get_margin_left; end

#get_margin_mask(margin) ⇒ Integer Also known as: margin_mask

Retrieve the marker mask of a margin.

Parameters:

  • margin (Integer)

Returns:

  • (Integer) 


1882
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1882

def get_margin_mask(margin) end

#get_margin_options ⇒ Integer Also known as: margin_options

Get the margin options.

The return value will be one of the wxSTC_MARGINOPTION_* constants.

Returns:

  • (Integer) 


2030
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2030

def get_margin_options; end

#get_margin_right ⇒ Integer Also known as: margin_right

Returns the size in pixels of the right margin.

Returns:

  • (Integer) 


1957
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1957

def get_margin_right; end

#get_margin_sensitive(margin) ⇒ Boolean Also known as: margin_sensitive

Retrieve the mouse click sensitivity of a margin.

Parameters:

  • margin (Integer)

Returns:

  • (Boolean) 


1894
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1894

def get_margin_sensitive(margin) end

#get_margin_type(margin) ⇒ Integer Also known as: margin_type

Retrieve the type of a margin.

The return value will be one of the wxSTC_MARGIN_* constants.

Parameters:

  • margin (Integer)

Returns:

  • (Integer) 


1858
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1858

def get_margin_type(margin) end

#get_margin_width(margin) ⇒ Integer Also known as: margin_width

Retrieve the width of a margin in pixels.

Parameters:

  • margin (Integer)

Returns:

  • (Integer) 


1870
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1870

def get_margin_width(margin) end

#get_marker_symbol_defined(markerNumber) ⇒ Integer Also known as: marker_symbol_defined

Which symbol was defined for markerNumber with MarkerDefine.

The return value will be one of the wxSTC_MARK_* constants.

Parameters:

  • markerNumber (Integer)

Returns:

  • (Integer) 


2690
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2690

def get_marker_symbol_defined(markerNumber) end

#get_max_line_state ⇒ Integer Also known as: max_line_state

Retrieve the last line number that has line state.

Returns:

  • (Integer) 


1419
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1419

def get_max_line_state; end

#get_mod_event_mask ⇒ Integer Also known as: mod_event_mask

Get which document modification events are sent to the container.

The return value will Wx::STC::STC_MODEVENTMASKALL if all changes generate events. Otherwise it will be a bit list containing one or more of the wxSTC_MOD* constants, the wxSTC_PERFORMED* constants, Wx::STC::STC_STARTACTION, Wx::STC::STC_MULTILINEUNDOREDO, Wx::STC::STC_MULTISTEPUNDOREDO, and Wx::STC::STC_LASTSTEPINUNDOREDO.

Returns:

  • (Integer) 


4078
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4078

def get_mod_event_mask; end

#get_modify ⇒ Boolean Also known as: modify

Is the document different from when it was last saved?

Returns:

  • (Boolean) 


584
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 584

def get_modify; end

#get_mouse_down_captures ⇒ Boolean Also known as: mouse_down_captures

Get whether mouse gets captured.

Returns:

  • (Boolean) 


1255
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1255

def get_mouse_down_captures; end

#get_mouse_dwell_time ⇒ Integer Also known as: mouse_dwell_time

Retrieve the time the mouse must sit still to generate a mouse dwell event.

The return value will be a time in milliseconds or Wx::STC::STC_TIME_FOREVER.

Returns:

  • (Integer) 


4063
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4063

def get_mouse_dwell_time; end

#get_mouse_selection_rectangular_switch ⇒ Boolean Also known as: mouse_selection_rectangular_switch

Whether switching to rectangular mode while selecting with the mouse is allowed.

Returns:

  • (Boolean) 


728
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 728

def get_mouse_selection_rectangular_switch; end

#get_mouse_wheel_captures ⇒ Boolean Also known as: mouse_wheel_captures

Get whether mouse wheel can be active outside the window.

Returns:

  • (Boolean) 


1266
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1266

def get_mouse_wheel_captures; end

#get_move_extends_selection ⇒ Boolean Also known as: move_extends_selection

Get whether or not regular caret moves will extend or reduce the selection.

Returns:

  • (Boolean) 


2334
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2334

def get_move_extends_selection; end

#get_multi_edge_column(which) ⇒ Integer Also known as: multi_edge_column

Get multi edge positions.

Parameters:

  • which (Integer)

Returns:

  • (Integer) 


2294
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2294

def get_multi_edge_column(which) end

#get_multi_paste ⇒ Integer Also known as: multi_paste

Retrieve the effect of pasting when there are multiple selections.

The return value will be one of the wxSTC_MULTIPASTE_* constants.

Returns:

  • (Integer) 


751
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 751

def get_multi_paste; end

#get_multiple_selection ⇒ Boolean Also known as: multiple_selection

Whether multiple selections can be made.

Returns:

  • (Boolean) 


762
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 762

def get_multiple_selection; end

#get_named_styles ⇒ Integer Also known as: named_styles

Retrieve the number of named styles for the lexer.

Returns:

  • (Integer) 


2414
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2414

def get_named_styles; end

#get_next_tab_stop(line, x) ⇒ Integer Also known as: next_tab_stop

Find the next explicit tab stop position on a line after a position.

Parameters:

  • line (Integer)
  • x (Integer)

Returns:

  • (Integer) 


2501
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2501

def get_next_tab_stop(line, x) end

#get_number_of_lines ⇒ Integer Also known as: number_of_lines

Returns the number of lines in the text control buffer.

The returned number is the number of logical lines, i.e. just the count of the number of newline characters in the control + 1, for WXGTK and WXOSX/Cocoa ports while it is the number of physical lines, i.e. the count of lines actually shown in the control, in WXMSW. Because of this discrepancy, it is not recommended to use this function.

Remark:

Note that even empty text controls have one line (where the insertion point is), so #get_number_of_lines never returns 0.

Returns:

  • (Integer) 


4364
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4364

def get_number_of_lines; end

#get_overtype ⇒ Boolean Also known as: overtype

Returns true if overtype mode is active otherwise false is returned.

Returns:

  • (Boolean) 


349
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 349

def get_overtype; end

#get_paste_convert_endings ⇒ Boolean Also known as: paste_convert_endings

Get convert-on-paste setting.

Returns:

  • (Boolean) 


395
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 395

def get_paste_convert_endings; end

#get_phases_draw ⇒ Integer Also known as: phases_draw

How many phases is drawing done in?

The return value will be one of the wxSTC_PHASES_* constants.

Returns:

  • (Integer) 


2238
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2238

def get_phases_draw; end

#get_position_cache_size ⇒ Integer Also known as: position_cache_size

How many entries are allocated to the position cache?

Returns:

  • (Integer) 


3835
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3835

def get_position_cache_size; end

#get_primary_style_from_style(style) ⇒ Integer Also known as: primary_style_from_style

For a secondary style, return the primary style, else return the argument.

Parameters:

  • style (Integer)

Returns:

  • (Integer) 


4029
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4029

def get_primary_style_from_style(style) end

#get_print_colour_mode ⇒ Integer Also known as: print_colour_mode

Returns the print colour mode.

The return value will be one of the wxSTC_PRINT_* constants.

Returns:

  • (Integer) 


3538
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3538

def get_print_colour_mode; end

#get_print_magnification ⇒ Integer Also known as: print_magnification

Returns the print magnification.

Returns:

  • (Integer) 


3523
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3523

def get_print_magnification; end

#get_print_wrap_mode ⇒ Integer Also known as: print_wrap_mode

Is printing line wrapped?

The return value will be one of the wxSTC_WRAP_* constants.

Returns:

  • (Integer) 


3562
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3562

def get_print_wrap_mode; end

#get_property(key) ⇒ String Also known as: property

Retrieve a “property” value previously set with SetProperty.

Parameters:

  • key (String)

Returns:

  • (String) 


3961
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3961

def get_property(key) end

#get_property_expanded(key) ⇒ String Also known as: property_expanded

Retrieve a “property” value previously set with SetProperty, with “$()” variable replacement on returned buffer.

Parameters:

  • key (String)

Returns:

  • (String) 


3967
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3967

def get_property_expanded(key) end

#get_property_int(key, defaultValue = 0) ⇒ Integer Also known as: property_int

Retrieve a “property” value previously set with SetProperty, interpreted as an int AFTER any “$()” variable replacement.

Parameters:

  • key (String)
  • defaultValue (Integer) (defaults to: 0)

Returns:

  • (Integer) 


3974
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3974

def get_property_int(key, defaultValue=0) end

#get_punctuation_chars ⇒ String Also known as: punctuation_chars

Get the set of characters making up punctuation characters.

Returns:

  • (String) 


1382
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1382

def get_punctuation_chars; end

#get_read_only ⇒ Boolean Also known as: read_only

In read-only mode?

Returns:

  • (Boolean) 


165
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 165

def get_read_only; end

#get_rectangular_selection_anchor ⇒ Integer Also known as: rectangular_selection_anchor

Return the anchor position of the rectangular selection.

Returns:

  • (Integer) 


925
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 925

def get_rectangular_selection_anchor; end

#get_rectangular_selection_anchor_virtual_space ⇒ Integer Also known as: rectangular_selection_anchor_virtual_space

Return the virtual space of the anchor of the rectangular selection.

Returns:

  • (Integer) 


947
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 947

def get_rectangular_selection_anchor_virtual_space; end

#get_rectangular_selection_caret ⇒ Integer Also known as: rectangular_selection_caret

Return the caret position of the rectangular selection.

Returns:

  • (Integer) 


914
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 914

def get_rectangular_selection_caret; end

#get_rectangular_selection_caret_virtual_space ⇒ Integer Also known as: rectangular_selection_caret_virtual_space

Return the virtual space of the caret of the rectangular selection.

Returns:

  • (Integer) 


936
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 936

def get_rectangular_selection_caret_virtual_space; end

#get_rectangular_selection_modifier ⇒ Integer Also known as: rectangular_selection_modifier

Get the modifier key used for rectangular selection.

The return value will be a bit list containing one or more of the wxSTC_KEYMOD_* constants.

Returns:

  • (Integer) 


977
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 977

def get_rectangular_selection_modifier; end

#get_representation(encodedCharacter) ⇒ String Also known as: representation

Set the way a character is drawn.

Parameters:

  • encodedCharacter (String)

Returns:

  • (String) 


1837
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1837

def get_representation(encodedCharacter) end

#get_scroll_width ⇒ Integer Also known as: scroll_width

Retrieve the document width assumed for scrolling.

Returns:

  • (Integer) 


1080
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1080

def get_scroll_width; end

#get_scroll_width_tracking ⇒ Boolean Also known as: scroll_width_tracking

Retrieve whether the scroll width tracks wide lines.

Returns:

  • (Boolean) 


1091
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1091

def get_scroll_width_tracking; end

#get_search_flags ⇒ Integer Also known as: search_flags

Get the search flags used by SearchInTarget.

The return value will be a bit list containing one or more of the wxSTC_FIND_* constants.

Returns:

  • (Integer) 


312
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 312

def get_search_flags; end

#get_sel_alpha ⇒ Integer Also known as: sel_alpha

Get the alpha of the selection.

Returns:

  • (Integer) 


1640
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1640

def get_sel_alpha; end

#get_sel_eol_filled ⇒ Boolean Also known as: sel_eol_filled

Is the selection end of line filled?

Returns:

  • (Boolean) 


1651
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1651

def get_sel_eol_filled; end

#get_selected_text ⇒ String Also known as: selected_text

Retrieve the selected text.

Returns:

  • (String) 


589
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 589

def get_selected_text; end

#get_selection ⇒ Array(Integer, Integer) Also known as: selection

Gets the current selection span.

If the returned values are equal, there was no selection. Please note that the indices returned may be used with the other TextCtrl methods but don’t necessarily represent the correct indices into the string returned by TextEntry#get_value for multiline controls under Windows (at least,) you should use TextEntry#get_string_selection to get the selected text.

Returns:

  • (Array(Integer, Integer)) 


4320
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4320

def get_selection; end

#get_selection_empty ⇒ Boolean Also known as: selection_empty

Is every selected range empty?

Returns:

  • (Boolean) 


805
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 805

def get_selection_empty; end

#get_selection_end ⇒ Integer Also known as: selection_end

Returns the position at the end of the selection.

Returns:

  • (Integer) 


566
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 566

def get_selection_end; end

#get_selection_mode ⇒ Integer Also known as: selection_mode

Get the mode of the current selection.

The return value will be one of the wxSTC_SEL_* constants.

Returns:

  • (Integer) 


683
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 683

def get_selection_mode; end

#get_selection_n_anchor(selection) ⇒ Integer Also known as: selection_n_anchor

Return the anchor position of the nth selection.

Parameters:

  • selection (Integer)

Returns:

  • (Integer) 


855
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 855

def get_selection_n_anchor(selection) end

#get_selection_n_anchor_virtual_space(selection) ⇒ Integer Also known as: selection_n_anchor_virtual_space

Return the virtual space of the anchor of the nth selection.

Parameters:

  • selection (Integer)

Returns:

  • (Integer) 


879
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 879

def get_selection_n_anchor_virtual_space(selection) end

#get_selection_n_caret(selection) ⇒ Integer Also known as: selection_n_caret

Return the caret position of the nth selection.

Parameters:

  • selection (Integer)

Returns:

  • (Integer) 


843
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 843

def get_selection_n_caret(selection) end

#get_selection_n_caret_virtual_space(selection) ⇒ Integer Also known as: selection_n_caret_virtual_space

Return the virtual space of the caret of the nth selection.

Parameters:

  • selection (Integer)

Returns:

  • (Integer) 


867
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 867

def get_selection_n_caret_virtual_space(selection) end

#get_selection_n_end(selection) ⇒ Integer Also known as: selection_n_end

Returns the position at the end of the selection.

Parameters:

  • selection (Integer)

Returns:

  • (Integer) 


903
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 903

def get_selection_n_end(selection) end

#get_selection_n_end_virtual_space(selection) ⇒ Integer Also known as: selection_n_end_virtual_space

Returns the virtual space at the end of the selection.

Parameters:

  • selection (Integer)

Returns:

  • (Integer) 


2346
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2346

def get_selection_n_end_virtual_space(selection) end

#get_selection_n_start(selection) ⇒ Integer Also known as: selection_n_start

Returns the position at the start of the selection.

Parameters:

  • selection (Integer)

Returns:

  • (Integer) 


891
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 891

def get_selection_n_start(selection) end

#get_selection_n_start_virtual_space(selection) ⇒ Integer Also known as: selection_n_start_virtual_space

Returns the virtual space at the start of the selection.

Parameters:

  • selection (Integer)

Returns:

  • (Integer) 


2340
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2340

def get_selection_n_start_virtual_space(selection) end

#get_selection_start ⇒ Integer Also known as: selection_start

Returns the position at the start of the selection.

Returns:

  • (Integer) 


555
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 555

def get_selection_start; end

#get_selections ⇒ Integer Also known as: selections

How many selections are there?

Returns:

  • (Integer) 


800
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 800

def get_selections; end

#get_status ⇒ Integer Also known as: status

Get error status.

The return value will be one of the wxSTC_STATUS_* constants.

Returns:

  • (Integer) 


414
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 414

def get_status; end

#get_stc_cursor ⇒ Integer Also known as: stc_cursor

Get cursor type.

The return value will be one of the wxSTC_CURSOR* constants.

Returns:

  • (Integer) 


1244
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1244

def get_stc_cursor; end

#get_stc_focus ⇒ Boolean Also known as: stc_focus

Get internal focus flag.

Returns:

  • (Boolean) 


2321
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2321

def get_stc_focus; end

#get_style(position, style) ⇒ Boolean Also known as: style

This method is inherited from TextAreaBase but is not implemented in Wx::STC::StyledTextCtrl.

Parameters:

Returns:

  • (Boolean) 


4397
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4397

def get_style(position, style) end

#get_style_at(pos) ⇒ Integer Also known as: style_at

Returns the style byte at the position.

Parameters:

  • pos (Integer)

Returns:

  • (Integer) 


156
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 156

def get_style_at(pos) end

#get_style_from_sub_style(subStyle) ⇒ Integer Also known as: style_from_sub_style

For a sub style, return the base style, else return the argument.

Parameters:

  • subStyle (Integer)

Returns:

  • (Integer) 


4023
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4023

def get_style_from_sub_style(subStyle) end

#get_sub_style_bases ⇒ String Also known as: sub_style_bases

Get the set of base styles that can be extended with sub styles.

Returns:

  • (String) 


4048
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4048

def get_sub_style_bases; end

#get_sub_styles_length(styleBase) ⇒ Integer Also known as: sub_styles_length

The number of sub styles associated with a base style.

Parameters:

  • styleBase (Integer)

Returns:

  • (Integer) 


4017
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4017

def get_sub_styles_length(styleBase) end

#get_sub_styles_start(styleBase) ⇒ Integer Also known as: sub_styles_start

The starting style number for the sub styles associated with a base style.

Parameters:

  • styleBase (Integer)

Returns:

  • (Integer) 


4011
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4011

def get_sub_styles_start(styleBase) end

#get_tab_draw_mode ⇒ Integer Also known as: tab_draw_mode

Retrieve the current tab draw mode.

Returns one of Wx::STC_TD_* constants.

Returns:

  • (Integer) 


1178
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1178

def get_tab_draw_mode; end

#get_tab_indents ⇒ Boolean Also known as: tab_indents

Does a tab pressed when caret is within indentation indent?

Returns:

  • (Boolean) 


2580
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2580

def get_tab_indents; end

#get_tab_minimum_width ⇒ Integer Also known as: tab_minimum_width

Get the minimum visual width of a tab.

Returns:

  • (Integer) 


2128
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2128

def get_tab_minimum_width; end

#get_tab_width ⇒ Integer Also known as: tab_width

Retrieve the visible size of a tab.

Returns:

  • (Integer) 


2483
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2483

def get_tab_width; end

#get_tag(tagNumber) ⇒ String Also known as: tag

Retrieve the value of a tag from a regular expression search.

Parameters:

  • tagNumber (Integer)

Returns:

  • (String) 


318
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 318

def get_tag(tagNumber) end

#get_target_end ⇒ Integer Also known as: target_end

Get the position that ends the target.

Returns:

  • (Integer) 


257
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 257

def get_target_end; end

#get_target_end_virtual_space ⇒ Integer Also known as: target_end_virtual_space

Get the virtual space of the target end.

Returns:

  • (Integer) 


2208
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2208

def get_target_end_virtual_space; end

#get_target_start ⇒ Integer Also known as: target_start

Get the position that starts the target.

Returns:

  • (Integer) 


246
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 246

def get_target_start; end

#get_target_start_virtual_space ⇒ Integer Also known as: target_start_virtual_space

Get the virtual space of the target start.

Returns:

  • (Integer) 


2197
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2197

def get_target_start_virtual_space; end

#get_target_text ⇒ String Also known as: target_text

Retrieve the text in the target.

Returns:

  • (String) 


268
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 268

def get_target_text; end

#get_technology ⇒ Integer Also known as: technology

Get the tech.

The return value will be one of the wxSTC_TECHNOLOGY_* constants.

Returns:

  • (Integer) 


2365
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2365

def get_technology; end

#get_text ⇒ String Also known as: text

Retrieve all the text in the document.

Returns:

  • (String) 


200
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 200

def get_text; end

#get_text_length ⇒ Integer Also known as: text_length

Retrieve the number of characters in the document.

Returns:

  • (Integer) 


614
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 614

def get_text_length; end

#get_text_range(startPos, endPos) ⇒ String Also known as: text_range

Retrieve a range of text.

Parameters:

  • startPos (Integer)
  • endPos (Integer)

Returns:

  • (String) 


178
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 178

def get_text_range(startPos, endPos) end

#get_undo_collection ⇒ Boolean Also known as: undo_collection

Is undo history being collected?

Returns:

  • (Boolean) 


434
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 434

def get_undo_collection; end

#get_use_anti_aliasing ⇒ Boolean Also known as: use_anti_aliasing

Returns the current UseAntiAliasing setting.

Returns:

  • (Boolean) 


4229
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4229

def get_use_anti_aliasing; end

#get_use_horizontal_scroll_bar ⇒ Boolean Also known as: use_horizontal_scroll_bar

Is the horizontal scroll bar visible?

Returns:

  • (Boolean) 


1046
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1046

def get_use_horizontal_scroll_bar; end

#get_use_tabs ⇒ Boolean Also known as: use_tabs

Retrieve whether tabs will be used in indentation.

Returns:

  • (Boolean) 


2523
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2523

def get_use_tabs; end

#get_use_vertical_scroll_bar ⇒ Boolean Also known as: use_vertical_scroll_bar

Is the vertical scroll bar visible?

Returns:

  • (Boolean) 


1115
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1115

def get_use_vertical_scroll_bar; end

#get_view_eol ⇒ Boolean Also known as: view_eol

Are the end of line characters visible?

Returns:

  • (Boolean) 


1289
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1289

def get_view_eol; end

#get_view_white_space ⇒ Integer Also known as: view_white_space

Are white space characters currently visible? Returns one of Wx::STC_WS_* constants.

Returns:

  • (Integer) 


1163
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1163

def get_view_white_space; end

#get_virtual_space_options ⇒ Integer Also known as: virtual_space_options

Return options for virtual space behaviour.

The return value will be one of the wxSTC_VS_* constants.

Returns:

  • (Integer) 


962
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 962

def get_virtual_space_options; end

#get_whitespace_chars ⇒ String Also known as: whitespace_chars

Get the set of characters making up whitespace for when moving or selecting by word.

Returns:

  • (String) 


1371
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1371

def get_whitespace_chars; end

#get_whitespace_size ⇒ Integer Also known as: whitespace_size

Get the size of the dots used to mark space characters.

Returns:

  • (Integer) 


1209
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1209

def get_whitespace_size; end

#get_word_chars ⇒ String Also known as: word_chars

Get the set of characters making up words for when moving or selecting by word.

Returns:

  • (String) 


1339
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1339

def get_word_chars; end

#get_wrap_indent_mode ⇒ Integer Also known as: wrap_indent_mode

Retrieve how wrapped sublines are placed.

Default is Wx::STC::STC_WRAPINDENT_FIXED. The return value will be one of the wxSTC_WRAPINDENT_* constants.

Returns:

  • (Integer) 


3808
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3808

def get_wrap_indent_mode; end

#get_wrap_mode ⇒ Integer Also known as: wrap_mode

Retrieve whether text is word wrapped.

The return value will be one of the wxSTC_WRAP_* constants.

Returns:

  • (Integer) 


3750
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3750

def get_wrap_mode; end

#get_wrap_start_indent ⇒ Integer Also known as: wrap_start_indent

Retrieve the start indent for wrapped lines.

Returns:

  • (Integer) 


3791
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3791

def get_wrap_start_indent; end

#get_wrap_visual_flags ⇒ Integer Also known as: wrap_visual_flags

Retrieve the display mode of visual flags for wrapped lines.

The return value will be a bit list containing one or more of the wxSTC_WRAPVISUALFLAG_* constants.

Returns:

  • (Integer) 


3765
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3765

def get_wrap_visual_flags; end

#get_wrap_visual_flags_location ⇒ Integer Also known as: wrap_visual_flags_location

Retrieve the location of visual flags for wrapped lines.

The return value will be a bit list containing one or more of the wxSTC_WRAPVISUALFLAGLOC_* constants.

Returns:

  • (Integer) 


3780
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3780

def get_wrap_visual_flags_location; end

#get_x_offset ⇒ Integer Also known as: x_offset

Get the xOffset (ie, horizontal scroll position).

Returns:

  • (Integer) 


1140
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1140

def get_x_offset; end

#get_zoom ⇒ Integer Also known as: zoom

Retrieve the zoom level.

Returns:

  • (Integer) 


3856
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3856

def get_zoom; end

#goto_line(line) ⇒ void

This method returns an undefined value.

Set caret to start of a line and ensure it is visible.

Parameters:

  • line (Integer) 


501
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 501

def goto_line(line) end

#goto_pos(caret) ⇒ void

This method returns an undefined value.

Set caret to a position and ensure it is visible.

Parameters:

  • caret (Integer) 


506
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 506

def goto_pos(caret) end

#hide_lines(lineStart, lineEnd) ⇒ void

This method returns an undefined value.

Make a range of lines invisible.

Parameters:

  • lineStart (Integer)
  • lineEnd (Integer) 


3617
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3617

def hide_lines(lineStart, lineEnd) end

#hide_selection(hide) ⇒ void

This method returns an undefined value.

Draw the selection either highlighted or in normal (non-highlighted) style.

Parameters:

  • hide (Boolean) 


595
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 595

def hide_selection(hide) end

#hit_test(pt) ⇒ Array(Wx::TextCtrlHitTestResult,Array(Integer, Integer))

Finds the row and column of the character at the specified point.

If the return code is not TextCtrlHitTestResult::TE_HT_UNKNOWN the row and column of the character closest to this position are returned, otherwise the output parameters are not modified. Please note that this function is currently only implemented in Univ, WXMSW and WXGTK2 ports and always returns TextCtrlHitTestResult::TE_HT_UNKNOWN in the other ports.

Parameters:

  • pt (Array(Integer, Integer), Wx::Point) —

    The position of the point to check, in window device coordinates.

Returns:

See Also:



4435
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4435

def hit_test(pt) end

#home ⇒ void

This method returns an undefined value.

Move caret to first position on line.



3156
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3156

def home; end

#home_display ⇒ void

This method returns an undefined value.

Move caret to first position on display line.



3294
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3294

def home_display; end

#home_display_extend ⇒ void

This method returns an undefined value.

Move caret to first position on display line extending selection to new caret position.



3298
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3298

def home_display_extend; end

#home_extend ⇒ void

This method returns an undefined value.

Move caret to first position on line extending selection to new caret position.



3160
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3160

def home_extend; end

#home_rect_extend ⇒ void

This method returns an undefined value.

Move caret to first position on line, extending rectangular selection to new caret position.



3394
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3394

def home_rect_extend; end

#home_wrap ⇒ void

This method returns an undefined value.

Like Home but when word-wrap is enabled goes first to start of display line HomeDisplay, then to start of document line Home.



3310
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3310

def home_wrap; end

#home_wrap_extend ⇒ void

This method returns an undefined value.

Like HomeExtend but when word-wrap is enabled extends first to start of display line HomeDisplayExtend, then to start of document line HomeExtend.



3314
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3314

def home_wrap_extend; end

#indicator_all_on_for(pos) ⇒ Integer

Are any indicators present at pos?

Parameters:

  • pos (Integer)

Returns:

  • (Integer) 


2819
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2819

def indicator_all_on_for(pos) end

#indicator_clear_range(start, lengthClear) ⇒ void

This method returns an undefined value.

Turn a indicator off over a range.

Parameters:

  • start (Integer)
  • lengthClear (Integer) 


2814
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2814

def indicator_clear_range(start, lengthClear) end

#indicator_end(indicator, pos) ⇒ Integer

Where does a particular indicator end?

Parameters:

  • indicator (Integer)
  • pos (Integer)

Returns:

  • (Integer) 


2837
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2837

def indicator_end(indicator, pos) end

#indicator_fill_range(start, lengthFill) ⇒ void

This method returns an undefined value.

Turn a indicator on over a range.

Parameters:

  • start (Integer)
  • lengthFill (Integer) 


2808
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2808

def indicator_fill_range(start, lengthFill) end

#indicator_get_alpha(indicator) ⇒ Integer

Get the alpha fill colour of the given indicator.

Parameters:

  • indicator (Integer)

Returns:

  • (Integer) 


2848
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2848

def indicator_get_alpha(indicator) end

#indicator_get_flags(indicator) ⇒ Integer

Retrieve the attributes of an indicator.

The return value will be a bit list containing one or more of the wxSTC_INDICFLAG_* constants.

Parameters:

  • indicator (Integer)

Returns:

  • (Integer) 


2780
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2780

def indicator_get_flags(indicator) end

#indicator_get_foreground(indicator) ⇒ Wx::Colour

Retrieve the foreground colour of an indicator.

Parameters:

  • indicator (Integer)

Returns:



2732
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2732

def indicator_get_foreground(indicator) end

#indicator_get_hover_foreground(indicator) ⇒ Wx::Colour

Retrieve the foreground hover colour of an indicator.

Parameters:

  • indicator (Integer)

Returns:



2765
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2765

def indicator_get_hover_foreground(indicator) end

#indicator_get_hover_style(indicator) ⇒ Integer

Retrieve the hover style of an indicator.

Parameters:

  • indicator (Integer)

Returns:

  • (Integer) 


2754
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2754

def indicator_get_hover_style(indicator) end

#indicator_get_outline_alpha(indicator) ⇒ Integer

Get the alpha outline colour of the given indicator.

Parameters:

  • indicator (Integer)

Returns:

  • (Integer) 


2859
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2859

def indicator_get_outline_alpha(indicator) end

#indicator_get_style(indicator) ⇒ Integer

Retrieve the style of an indicator.

The return value will be one of the wxSTC_INDIC_* constants.

Parameters:

  • indicator (Integer)

Returns:

  • (Integer) 


2721
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2721

def indicator_get_style(indicator) end

#indicator_get_under(indicator) ⇒ Boolean

Retrieve whether indicator drawn under or over text.

Parameters:

  • indicator (Integer)

Returns:

  • (Boolean) 


2743
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2743

def indicator_get_under(indicator) end

#indicator_set_alpha(indicator, alpha) ⇒ void

This method returns an undefined value.

Set the alpha fill colour of the given indicator.

Parameters:

  • indicator (Integer)
  • alpha (Integer) 


2843
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2843

def indicator_set_alpha(indicator, alpha) end

#indicator_set_flags(indicator, flags) ⇒ void

This method returns an undefined value.

Set the attributes of an indicator.

The second argument should be a bit list containing one or more of the wxSTC_INDICFLAG_* constants.

Parameters:

  • indicator (Integer)
  • flags (Integer) 


2773
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2773

def indicator_set_flags(indicator, flags) end

#indicator_set_foreground(indicator, fore) ⇒ void

This method returns an undefined value.

Set the foreground colour of an indicator.

Parameters:

  • indicator (Integer)
  • fore (Wx::Colour, String, Symbol) 


2727
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2727

def indicator_set_foreground(indicator, fore) end

#indicator_set_hover_foreground(indicator, fore) ⇒ void

This method returns an undefined value.

Set the foreground hover colour of an indicator.

Parameters:

  • indicator (Integer)
  • fore (Wx::Colour, String, Symbol) 


2760
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2760

def indicator_set_hover_foreground(indicator, fore) end

#indicator_set_hover_style(indicator, indicatorStyle) ⇒ void

This method returns an undefined value.

Set a hover indicator to plain, squiggle or TT.

Parameters:

  • indicator (Integer)
  • indicatorStyle (Integer) 


2749
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2749

def indicator_set_hover_style(indicator, indicatorStyle) end

#indicator_set_outline_alpha(indicator, alpha) ⇒ void

This method returns an undefined value.

Set the alpha outline colour of the given indicator.

Parameters:

  • indicator (Integer)
  • alpha (Integer) 


2854
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2854

def indicator_set_outline_alpha(indicator, alpha) end

#indicator_set_style(indicator, indicatorStyle) ⇒ void

This method returns an undefined value.

Set an indicator to plain, squiggle or TT.

The second argument should be one of the wxSTC_INDIC_* constants.

Parameters:

  • indicator (Integer)
  • indicatorStyle (Integer) 


2714
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2714

def indicator_set_style(indicator, indicatorStyle) end

#indicator_set_under(indicator, under) ⇒ void

This method returns an undefined value.

Set an indicator to draw under text or over(default).

Parameters:

  • indicator (Integer)
  • under (Boolean) 


2738
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2738

def indicator_set_under(indicator, under) end

#indicator_start(indicator, pos) ⇒ Integer

Where does a particular indicator start?

Parameters:

  • indicator (Integer)
  • pos (Integer)

Returns:

  • (Integer) 


2831
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2831

def indicator_start(indicator, pos) end

#indicator_value_at(indicator, pos) ⇒ Integer

What value does a particular indicator have at a position?

Parameters:

  • indicator (Integer)
  • pos (Integer)

Returns:

  • (Integer) 


2825
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2825

def indicator_value_at(indicator, pos) end

#insert_text(pos, text) ⇒ void

This method returns an undefined value.

Insert string at a position.

Parameters:

  • pos (Integer)
  • text (String) 


125
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 125

def insert_text(pos, text) end

#is_editable ⇒ Boolean Also known as: editable?

Returns true if the controls contents may be edited by user (note that it always can be changed by the program).

In other words, this functions returns true if the control hasn’t been put in read-only mode by a previous call to #set_editable.

Returns:

  • (Boolean) 


4327
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4327

def is_editable; end

#is_modified ⇒ Boolean Also known as: modified?

Returns true if the text has been modified by user.

Note that calling TextEntry#set_value doesn’t make the control modified.

Returns:

  • (Boolean)

See Also:



4372
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4372

def is_modified; end

#is_range_word(start, end_) ⇒ Boolean Also known as: range_word?

Is the range start..end considered a word?

Parameters:

  • start (Integer)
  • end_ (Integer)

Returns:

  • (Boolean) 


1358
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1358

def is_range_word(start, end_) end

#line_copy ⇒ void

This method returns an undefined value.

Copy the line containing the caret.



3334
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3334

def line_copy; end

#line_cut ⇒ void

This method returns an undefined value.

Cut the line containing the caret.



3256
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3256

def line_cut; end

#line_delete ⇒ void

This method returns an undefined value.

Delete the line containing the caret.



3260
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3260

def line_delete; end

#line_down ⇒ void

This method returns an undefined value.

Move caret down one line.



3108
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3108

def line_down; end

#line_down_extend ⇒ void

This method returns an undefined value.

Move caret down one line extending selection to new caret position.



3112
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3112

def line_down_extend; end

#line_down_rect_extend ⇒ void

This method returns an undefined value.

Move caret down one line, extending rectangular selection to new caret position.



3378
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3378

def line_down_rect_extend; end

#line_duplicate ⇒ void

This method returns an undefined value.

Duplicate the current line.



3268
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3268

def line_duplicate; end

#line_end ⇒ void

This method returns an undefined value.

Move caret to last position on line.



3164
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3164

def line_end; end

#line_end_display ⇒ void

This method returns an undefined value.

Move caret to last position on display line.



3302
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3302

def line_end_display; end

#line_end_display_extend ⇒ void

This method returns an undefined value.

Move caret to last position on display line extending selection to new caret position.



3306
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3306

def line_end_display_extend; end

#line_end_extend ⇒ void

This method returns an undefined value.

Move caret to last position on line extending selection to new caret position.



3168
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3168

def line_end_extend; end

#line_end_rect_extend ⇒ void

This method returns an undefined value.

Move caret to last position on line, extending rectangular selection to new caret position.



3404
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3404

def line_end_rect_extend; end

#line_end_wrap ⇒ void

This method returns an undefined value.

Like LineEnd but when word-wrap is enabled goes first to end of display line LineEndDisplay, then to start of document line LineEnd.



3318
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3318

def line_end_wrap; end

#line_end_wrap_extend ⇒ void

This method returns an undefined value.

Like LineEndExtend but when word-wrap is enabled extends first to end of display line LineEndDisplayExtend, then to start of document line LineEndExtend.



3322
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3322

def line_end_wrap_extend; end

#line_from_position(pos) ⇒ Integer

Retrieve the line containing a position.

Parameters:

  • pos (Integer)

Returns:

  • (Integer) 


605
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 605

def line_from_position(pos) end

#line_length(line) ⇒ Integer

How many characters are on a line, including end of line characters?

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


637
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 637

def line_length(line) end

#line_reverse ⇒ void

This method returns an undefined value.

Reverse order of selected lines.



2283
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2283

def line_reverse; end

#line_scroll(columns, lines) ⇒ void

This method returns an undefined value.

Scroll horizontally and vertically.

Parameters:

  • columns (Integer)
  • lines (Integer) 


1058
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1058

def line_scroll(columns, lines) end

#line_scroll_down ⇒ void

This method returns an undefined value.

Scroll the document down, keeping the caret visible.



3280
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3280

def line_scroll_down; end

#line_scroll_up ⇒ void

This method returns an undefined value.

Scroll the document up, keeping the caret visible.



3284
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3284

def line_scroll_up; end

#line_transpose ⇒ void

This method returns an undefined value.

Switch the current line with the previous.



3264
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3264

def line_transpose; end

#line_up ⇒ void

This method returns an undefined value.

Move caret up one line.



3116
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3116

def line_up; end

#line_up_extend ⇒ void

This method returns an undefined value.

Move caret up one line extending selection to new caret position.



3120
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3120

def line_up_extend; end

#line_up_rect_extend ⇒ void

This method returns an undefined value.

Move caret up one line, extending rectangular selection to new caret position.



3382
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3382

def line_up_rect_extend; end

#lines_join ⇒ void

This method returns an undefined value.

Join the lines in the target.



3820
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3820

def lines_join; end

#lines_on_screen ⇒ Integer

Retrieves the number of lines completely visible.

Returns:

  • (Integer) 


641
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 641

def lines_on_screen; end

#lines_split(pixelWidth) ⇒ void

This method returns an undefined value.

Split the lines in the target into lines that are less wide than pixelWidth where possible.

Parameters:

  • pixelWidth (Integer) 


3825
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3825

def lines_split(pixelWidth) end

#load_file(filename) ⇒ Boolean

Load the contents of filename into the editor.

Parameters:

  • filename (String)

Returns:

  • (Boolean) 


4192
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4192

def load_file(filename) end

#load_lexer_library(path) ⇒ void

This method returns an undefined value.

Load a lexer library (dll / so).

Parameters:

  • path (String) 


3956
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3956

def load_lexer_library(path) end

#lower_case ⇒ void

This method returns an undefined value.

Transform the selection to lower case.



3272
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3272

def lower_case; end

#margin_get_style(line) ⇒ Integer

Get the style number for the text margin for a line.

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


1992
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1992

def margin_get_style(line) end

#margin_get_style_offset ⇒ Integer

Get the start of the range of style numbers used for margin text.

Returns:

  • (Integer) 


2016
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2016

def margin_get_style_offset; end

#margin_get_styles(line) ⇒ String

Get the styles in the text margin for a line.

Parameters:

  • line (Integer)

Returns:

  • (String) 


2003
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2003

def margin_get_styles(line) end

#margin_get_text(line) ⇒ String

Get the text in the text margin for a line.

Parameters:

  • line (Integer)

Returns:

  • (String) 


1981
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1981

def margin_get_text(line) end

#margin_set_style(line, style) ⇒ void

This method returns an undefined value.

Set the style number for the text margin for a line.

Parameters:

  • line (Integer)
  • style (Integer) 


1987
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1987

def margin_set_style(line, style) end

#margin_set_style_offset(style) ⇒ void

This method returns an undefined value.

Get the start of the range of style numbers used for margin text.

Parameters:

  • style (Integer) 


2012
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2012

def margin_set_style_offset(style) end

#margin_set_styles(line, styles) ⇒ void

This method returns an undefined value.

Set the style in the text margin for a line.

Parameters:

  • line (Integer)
  • styles (String) 


1998
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1998

def margin_set_styles(line, styles) end

#margin_set_text(line, text) ⇒ void

This method returns an undefined value.

Set the text in the text margin for a line.

Parameters:

  • line (Integer)
  • text (String) 


1976
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1976

def margin_set_text(line, text) end

#margin_text_clear_all ⇒ void

This method returns an undefined value.

Clear the margin text on all lines.



2007
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2007

def margin_text_clear_all; end

#mark_dirty ⇒ void

This method returns an undefined value.

Mark text as modified (dirty).

See Also:



4380
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4380

def mark_dirty; end

#marker_add(line, markerNumber) ⇒ Integer

Add a marker to a line, returning an ID which can be used to find or delete the marker.

Parameters:

  • line (Integer)
  • markerNumber (Integer)

Returns:

  • (Integer) 


2641
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2641

def marker_add(line, markerNumber) end

#marker_add_set(line, markerSet) ⇒ void

This method returns an undefined value.

Add a set of markers to a line.

Parameters:

  • line (Integer)
  • markerSet (Integer) 


2677
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2677

def marker_add_set(line, markerSet) end

#marker_define(markerNumber, markerSymbol, foreground = Wx::NULL_COLOUR, background = Wx::NULL_COLOUR) ⇒ void

This method returns an undefined value.

Set the symbol used for a particular marker number, and optionally the fore and background colours.

The second argument should be one of the wxSTC_MARK_* constants.

Parameters:

  • markerNumber (Integer)
  • markerSymbol (Integer)
  • foreground (Wx::Colour, String, Symbol) (defaults to: Wx::NULL_COLOUR)
  • background (Wx::Colour, String, Symbol) (defaults to: Wx::NULL_COLOUR) 


2612
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2612

def marker_define(markerNumber, markerSymbol, foreground=Wx::NULL_COLOUR, background=Wx::NULL_COLOUR) end

#marker_define_bitmap(markerNumber, bmp) ⇒ void

This method returns an undefined value.

Define a marker with a Bitmap.

Parameters:



4241
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4241

def marker_define_bitmap(markerNumber, bmp) end

#marker_delete(line, markerNumber) ⇒ void

This method returns an undefined value.

Delete a marker from a line.

Parameters:

  • line (Integer)
  • markerNumber (Integer) 


2647
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2647

def marker_delete(line, markerNumber) end

#marker_delete_all(markerNumber) ⇒ void

This method returns an undefined value.

Delete all markers with a particular number from all lines.

Parameters:

  • markerNumber (Integer) 


2652
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2652

def marker_delete_all(markerNumber) end

#marker_delete_handle(markerHandle) ⇒ void

This method returns an undefined value.

Delete a marker.

Parameters:

  • markerHandle (Integer) 


2602
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2602

def marker_delete_handle(markerHandle) end

#marker_enable_highlight(enabled) ⇒ void

This method returns an undefined value.

Enable/disable highlight for current folding block (smallest one that contains the caret)

Parameters:

  • enabled (Boolean) 


2635
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2635

def marker_enable_highlight(enabled) end

#marker_get(line) ⇒ Integer

Get a bit mask of all the markers set on a line.

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


2657
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2657

def marker_get(line) end

#marker_handle_from_line(line, which) ⇒ Integer

Retrieve marker handles of a line.

Parameters:

  • line (Integer)
  • which (Integer)

Returns:

  • (Integer) 


2101
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2101

def marker_handle_from_line(line, which) end

#marker_line_from_handle(markerHandle) ⇒ Integer

Retrieve the line number at which a particular marker is located.

Parameters:

  • markerHandle (Integer)

Returns:

  • (Integer) 


2597
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2597

def marker_line_from_handle(markerHandle) end

#marker_next(lineStart, markerMask) ⇒ Integer

Find the next line at or after lineStart that includes a marker in mask.

Return -1 when no more lines.

Parameters:

  • lineStart (Integer)
  • markerMask (Integer)

Returns:

  • (Integer) 


2665
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2665

def marker_next(lineStart, markerMask) end

#marker_number_from_line(line, which) ⇒ Integer

Retrieve marker number of a marker handle.

Parameters:

  • line (Integer)
  • which (Integer)

Returns:

  • (Integer) 


2107
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2107

def marker_number_from_line(line, which) end

#marker_previous(lineStart, markerMask) ⇒ Integer

Find the previous line before lineStart that includes a marker in mask.

Parameters:

  • lineStart (Integer)
  • markerMask (Integer)

Returns:

  • (Integer) 


2671
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2671

def marker_previous(lineStart, markerMask) end

#marker_set_alpha(markerNumber, alpha) ⇒ void

This method returns an undefined value.

Set the alpha used for a marker that is drawn in the text area, not the margin.

Parameters:

  • markerNumber (Integer)
  • alpha (Integer) 


2683
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2683

def marker_set_alpha(markerNumber, alpha) end

#marker_set_background(markerNumber, back) ⇒ void

This method returns an undefined value.

Set the background colour used for a particular marker number.

Parameters:

  • markerNumber (Integer)
  • back (Wx::Colour, String, Symbol) 


2624
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2624

def marker_set_background(markerNumber, back) end

#marker_set_background_selected(markerNumber, back) ⇒ void

This method returns an undefined value.

Set the background colour used for a particular marker number when its folding block is selected.

Parameters:

  • markerNumber (Integer)
  • back (Wx::Colour, String, Symbol) 


2630
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2630

def marker_set_background_selected(markerNumber, back) end

#marker_set_foreground(markerNumber, fore) ⇒ void

This method returns an undefined value.

Set the foreground colour used for a particular marker number.

Parameters:

  • markerNumber (Integer)
  • fore (Wx::Colour, String, Symbol) 


2618
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2618

def marker_set_foreground(markerNumber, fore) end

#move_caret_inside_view ⇒ void

This method returns an undefined value.

Move the caret inside current view if it’s not there already.



632
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 632

def move_caret_inside_view; end

#move_selected_lines_down ⇒ void

This method returns an undefined value.

Move the selected lines down one line, shifting the line below before the selection.



737
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 737

def move_selected_lines_down; end

#move_selected_lines_up ⇒ void

This method returns an undefined value.

Move the selected lines up one line, shifting the line above after the selection.



733
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 733

def move_selected_lines_up; end

#multi_edge_add_line(column, edgeColour) ⇒ void

This method returns an undefined value.

Add a new vertical edge to the view.

Parameters:

  • column (Integer)
  • edgeColour (Wx::Colour, String, Symbol) 


3902
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3902

def multi_edge_add_line(column, edgeColour) end

#multi_edge_clear_all ⇒ void

This method returns an undefined value.

Clear all vertical edges.



3906
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3906

def multi_edge_clear_all; end

#multiple_select_add_each ⇒ void

This method returns an undefined value.

Add each occurrence of the main selection in the target to the set of selections.

If the current selection is empty then select word around caret.



1036
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1036

def multiple_select_add_each; end

#multiple_select_add_next ⇒ void

This method returns an undefined value.

Add the next occurrence of the main selection to the set of selections as main.

If the current selection is empty then select word around caret.



1030
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1030

def multiple_select_add_next; end

#name_of_style(style) ⇒ String

Retrieve the name of a style.

Result is NUL-terminated.

Parameters:

  • style (Integer)

Returns:

  • (String) 


2422
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2422

def name_of_style(style) end

#new_line ⇒ void

This method returns an undefined value.

Insert a new line, may use a CRLF, CR or LF depending on EOL mode.



3226
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3226

def new_line; end

#page_down ⇒ void

This method returns an undefined value.

Move caret one page down.



3196
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3196

def page_down; end

#page_down_extend ⇒ void

This method returns an undefined value.

Move caret one page down extending selection to new caret position.



3200
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3200

def page_down_extend; end

#page_down_rect_extend ⇒ void

This method returns an undefined value.

Move caret one page down, extending rectangular selection to new caret position.



3412
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3412

def page_down_rect_extend; end

#page_up ⇒ void

This method returns an undefined value.

Move caret one page up.



3188
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3188

def page_up; end

#page_up_extend ⇒ void

This method returns an undefined value.

Move caret one page up extending selection to new caret position.



3192
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3192

def page_up_extend; end

#page_up_rect_extend ⇒ void

This method returns an undefined value.

Move caret one page up, extending rectangular selection to new caret position.



3408
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3408

def page_up_rect_extend; end

#para_down ⇒ void

This method returns an undefined value.

Move caret down one paragraph (delimited by empty lines).



3362
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3362

def para_down; end

#para_down_extend ⇒ void

This method returns an undefined value.

Extend selection down one paragraph (delimited by empty lines).



3366
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3366

def para_down_extend; end

#para_up ⇒ void

This method returns an undefined value.

Move caret up one paragraph (delimited by empty lines).



3370
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3370

def para_up; end

#para_up_extend ⇒ void

This method returns an undefined value.

Extend selection up one paragraph (delimited by empty lines).



3374
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3374

def para_up_extend; end

#paste ⇒ void

This method returns an undefined value.

Paste the contents of the clipboard into the document replacing the selection.



367
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 367

def paste; end

#point_from_position(pos) ⇒ Wx::Point

Retrieve the point in the window where a position is displayed.

Parameters:

  • pos (Integer)

Returns:



600
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 600

def point_from_position(pos) end

#position_after(pos) ⇒ Integer

Given a valid document position, return the next position taking code page into account.

Maximum value returned is the last position in the document.

Parameters:

  • pos (Integer)

Returns:

  • (Integer) 


663
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 663

def position_after(pos) end

#position_before(pos) ⇒ Integer

Given a valid document position, return the previous position taking code page into account.

Returns 0 if passed 0.

Parameters:

  • pos (Integer)

Returns:

  • (Integer) 


656
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 656

def position_before(pos) end

#position_from_line(line) ⇒ Integer

Retrieve the position at the start of a line.

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


610
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 610

def position_from_line(line) end

#position_from_point(pt) ⇒ Integer

Find the position from a point within the window.

Parameters:

Returns:

  • (Integer) 


490
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 490

def position_from_point(pt) end

#position_from_point_close(x, y) ⇒ Integer

Find the position from a point within the window but return Wx::STC::STC_INVALID_POSITION if not close to text.

Parameters:

  • x (Integer)
  • y (Integer)

Returns:

  • (Integer) 


496
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 496

def position_from_point_close(x, y) end

#position_relative(pos, relative) ⇒ Integer

Given a valid document position, return a position that differs in a number of characters.

Returned value is always between 0 and last position in document.

Parameters:

  • pos (Integer)
  • relative (Integer)

Returns:

  • (Integer) 


671
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 671

def position_relative(pos, relative) end

#position_relative_code_units(pos, relative) ⇒ Integer

Given a valid document position, return a position that differs in a number of UTF-16 code units.

Returned value is always between 0 and last position in document. The result may point half way (2 bytes) inside a non-BMP character.

Parameters:

  • pos (Integer)
  • relative (Integer)

Returns:

  • (Integer) 


2330
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2330

def position_relative_code_units(pos, relative) end

#position_to_xy(pos) ⇒ Array(Boolean,Array(Integer, Integer))

Converts given position to a zero-based column, line number pair.

true on success, false on failure (most likely due to a too large position parameter).

Parameters:

  • pos (Integer) —

    Position.

Returns:

  • (Array(Boolean,Array(Integer, Integer)))

See Also:



4420
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4420

def position_to_xy(pos) end

#property_names ⇒ String

Retrieve a ‘n’ separated list of properties understood by the current lexer.

Returns:

  • (String) 


3984
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3984

def property_names; end

#property_type(name) ⇒ Integer

Retrieve the type of a property.

The return value will be one of the wxSTC_TYPE_* constants.

Parameters:

  • name (String)

Returns:

  • (Integer) 


3991
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3991

def property_type(name) end

#redo_ ⇒ void

This method returns an undefined value.

Redoes the next action on the undo history.



419
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 419

def redo_; end

#register_image(type, bmp) ⇒ void

This method returns an undefined value.

Register an image for use in autocompletion lists.

Parameters:



2960
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2960

def register_image(type, bmp) end

#release_all_extended_styles ⇒ void

This method returns an undefined value.

Release all extended (>255) style numbers.



215
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 215

def release_all_extended_styles; end

#remove(from, to) ⇒ void

This method returns an undefined value.

Removes the text starting at the first given position up to (but not including) the character at the last position.

This function puts the current insertion point position at to as a side effect.

Parameters:

  • from (Integer) —

    The first position.

  • to (Integer) —

    The last position.



4260
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4260

def remove(from, to) end

#replace(from, to, value) ⇒ void

This method returns an undefined value.

Replaces the text starting at the first position up to (but not including) the character at the last position with the given text.

This function puts the current insertion point position at to as a side effect.

Parameters:

  • from (Integer) —

    The first position.

  • to (Integer) —

    The last position.

  • value (String) —

    The value to replace the existing text with.



4269
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4269

def replace(from, to, value) end

#replace_selection(text) ⇒ void

This method returns an undefined value.

Replace the selected text with the argument text.

Parameters:

  • text (String) 


184
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 184

def replace_selection(text) end

#replace_target(text) ⇒ Integer

Replace the target text with the argument text.

Text is counted so it can contain NULs. Returns the length of the replacement text.

Parameters:

  • text (String)

Returns:

  • (Integer) 


284
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 284

def replace_target(text) end

#replace_target_re(text) ⇒ Integer

Replace the target text with the argument text after d processing.

Text is counted so it can contain NULs. Looks for d where d is between 1 and 9 and replaces these with the strings matched in the last search operation which were surrounded by ( and ). Returns the length of the replacement text including any change caused by processing the d patterns.

Parameters:

  • text (String)

Returns:

  • (Integer) 


291
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 291

def replace_target_re(text) end

#rgba_image_set_height(height) ⇒ void

This method returns an undefined value.

Set the height for future RGBA image data.

Parameters:

  • height (Integer) 


2701
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2701

def rgba_image_set_height(height) end

#rgba_image_set_scale(scalePercent) ⇒ void

This method returns an undefined value.

Set the scale factor in percent for future RGBA image data.

Parameters:

  • scalePercent (Integer) 


2706
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2706

def rgba_image_set_scale(scalePercent) end

#rgba_image_set_width(width) ⇒ void

This method returns an undefined value.

Set the width for future RGBA image data.

Parameters:

  • width (Integer) 


2696
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2696

def rgba_image_set_width(width) end

#rotate_selection ⇒ void

This method returns an undefined value.

Set the main selection to the next selection.



1020
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1020

def rotate_selection; end

#save_file(filename) ⇒ Boolean

Write the contents of the editor to filename.

Parameters:

  • filename (String)

Returns:

  • (Boolean) 


4187
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4187

def save_file(filename) end

#scroll_range(secondary, primary) ⇒ void

This method returns an undefined value.

Scroll the argument positions and the range between them into view giving priority to the primary position then the secondary position.

This may be used to make a search match visible.

Parameters:

  • secondary (Integer)
  • primary (Integer) 


1070
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1070

def scroll_range(secondary, primary) end

#scroll_to_column(column) ⇒ void

This method returns an undefined value.

Scroll enough to make the given column visible.

Parameters:

  • column (Integer) 


4152
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4152

def scroll_to_column(column) end

#scroll_to_end ⇒ void

This method returns an undefined value.

Scroll to end of document.



3462
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3462

def scroll_to_end; end

#scroll_to_line(line) ⇒ void

This method returns an undefined value.

Scroll enough to make the given line visible.

Parameters:

  • line (Integer) 


4147
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4147

def scroll_to_line(line) end

#scroll_to_start ⇒ void

This method returns an undefined value.

Scroll to start of document.



3458
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3458

def scroll_to_start; end

#search_anchor ⇒ void

This method returns an undefined value.

Sets the current caret position to be the search anchor.



323
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 323

def search_anchor; end

#search_in_target(text) ⇒ Integer

Search for a counted string in the target and set the target to the found range.

Text is counted so it can contain NULs. Returns start of found range or -1 for failure in which case target is not moved.

Parameters:

  • text (String)

Returns:

  • (Integer) 


298
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 298

def search_in_target(text) end

#search_next(searchFlags, text) ⇒ Integer

Find some text starting at the search anchor.

Does not ensure the selection is visible.

Parameters:

  • searchFlags (Integer)
  • text (String)

Returns:

  • (Integer) 


331
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 331

def search_next(searchFlags, text) end

#search_prev(searchFlags, text) ⇒ Integer

Find some text starting at the search anchor and moving backwards.

Does not ensure the selection is visible.

Parameters:

  • searchFlags (Integer)
  • text (String)

Returns:

  • (Integer) 


339
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 339

def search_prev(searchFlags, text) end

#select_all ⇒ void

This method returns an undefined value.

Select all the text in the document.



485
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 485

def select_all; end

#select_none ⇒ void

This method returns an undefined value.

Deselects selected text in the control.



4314
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4314

def select_none; end

#selection_duplicate ⇒ void

This method returns an undefined value.

Duplicate the selection.

If selection empty duplicate the line containing the caret.



3450
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3450

def selection_duplicate; end

#selection_is_rectangle ⇒ Boolean

Is the selection rectangular? The alternative is the more common stream selection.

Returns:

  • (Boolean) 


645
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 645

def selection_is_rectangle; end

#send_msg(msg, wp = 0, lp = 0) ⇒ Integer

Scintilla API call.

Parameters:

  • msg (Integer)
  • wp (Integer) (defaults to: 0)
  • lp (Integer) (defaults to: 0)

Returns:

  • (Integer) 


4159
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4159

def send_msg(msg, wp=0, lp=0) end

#set_accessibility(accessibility) ⇒ void Also known as: accessibility=

This method returns an undefined value.

Enable or disable accessibility.

Parameters:

  • accessibility (Integer) 


2273
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2273

def set_accessibility(accessibility) end

#set_additional_caret_foreground(fore) ⇒ void Also known as: additional_caret_foreground=

This method returns an undefined value.

Set the foreground colour of additional carets.

Parameters:



1010
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1010

def set_additional_caret_foreground(fore) end

#set_additional_carets_blink(additionalCaretsBlink) ⇒ void Also known as: additional_carets_blink=

This method returns an undefined value.

Set whether additional carets will blink.

Parameters:

  • additionalCaretsBlink (Boolean) 


779
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 779

def set_additional_carets_blink(additionalCaretsBlink) end

#set_additional_carets_visible(additionalCaretsVisible) ⇒ void Also known as: additional_carets_visible=

This method returns an undefined value.

Set whether additional carets are visible.

Parameters:

  • additionalCaretsVisible (Boolean) 


790
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 790

def set_additional_carets_visible(additionalCaretsVisible) end

#set_additional_sel_alpha(alpha) ⇒ void Also known as: additional_sel_alpha=

This method returns an undefined value.

Set the alpha of the selection.

Parameters:

  • alpha (Integer) 


999
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 999

def set_additional_sel_alpha(alpha) end

#set_additional_sel_background(back) ⇒ void Also known as: additional_sel_background=

This method returns an undefined value.

Set the background colour of additional selections.

Must have previously called SetSelBack with non-zero first argument for this to have an effect.

Parameters:



993
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 993

def set_additional_sel_background(back) end

#set_additional_sel_foreground(fore) ⇒ void Also known as: additional_sel_foreground=

This method returns an undefined value.

Set the foreground colour of additional selections.

Must have previously called SetSelFore with non-zero first argument for this to have an effect.

Parameters:



985
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 985

def set_additional_sel_foreground(fore) end

#set_additional_selection_typing(additionalSelectionTyping) ⇒ void Also known as: additional_selection_typing=

This method returns an undefined value.

Set whether typing can be performed into multiple selections.

Parameters:

  • additionalSelectionTyping (Boolean) 


768
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 768

def set_additional_selection_typing(additionalSelectionTyping) end

#set_anchor(anchor) ⇒ void Also known as: anchor=

This method returns an undefined value.

Set the selection anchor to a position.

The anchor is the opposite end of the selection from the caret.

Parameters:

  • anchor (Integer) 


513
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 513

def set_anchor(anchor) end

#set_automatic_fold(automaticFold) ⇒ void Also known as: automatic_fold=

This method returns an undefined value.

Set automatic folding behaviours.

The input should be a bit list containing one or more of the wxSTC_AUTOMATICFOLD_* constants.

Parameters:

  • automaticFold (Integer) 


3701
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3701

def set_automatic_fold(automaticFold) end

#set_back_space_un_indents(bsUnIndents) ⇒ void Also known as: back_space_un_indents=

This method returns an undefined value.

Sets whether a backspace pressed when caret is within indentation unindents.

Parameters:

  • bsUnIndents (Boolean) 


2586
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2586

def set_back_space_un_indents(bsUnIndents) end

#set_buffered_draw(buffered) ⇒ void Also known as: buffered_draw=

This method returns an undefined value.

If drawing is buffered then each line of text is drawn into a bitmap buffer before drawing it to the screen to avoid flicker.

Parameters:

  • buffered (Boolean) 


2117
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2117

def set_buffered_draw(buffered) end

#set_caret_foreground(fore) ⇒ void Also known as: caret_foreground=

This method returns an undefined value.

Set the foreground colour of the caret.

Parameters:



1663
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1663

def set_caret_foreground(fore) end

#set_caret_line_back_alpha(alpha) ⇒ void Also known as: caret_line_back_alpha=

This method returns an undefined value.

Set background alpha of the caret line.

Parameters:

  • alpha (Integer) 


1783
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1783

def set_caret_line_back_alpha(alpha) end

#set_caret_line_background(back) ⇒ void Also known as: caret_line_background=

This method returns an undefined value.

Set the colour of the background of the line containing the caret.

Parameters:



1698
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1698

def set_caret_line_background(back) end

#set_caret_line_frame(width) ⇒ void Also known as: caret_line_frame=

This method returns an undefined value.

Display the caret line framed.

Set width != 0 to enable this option and width = 0 to disable it.

Parameters:

  • width (Integer) 


2175
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2175

def set_caret_line_frame(width) end

#set_caret_line_visible(show) ⇒ void Also known as: caret_line_visible=

This method returns an undefined value.

Display the background of the line containing the caret in a different colour.

Parameters:

  • show (Boolean) 


1687
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1687

def set_caret_line_visible(show) end

#set_caret_line_visible_always(alwaysVisible) ⇒ void Also known as: caret_line_visible_always=

This method returns an undefined value.

Sets the caret line to always visible.

Parameters:

  • alwaysVisible (Boolean) 


1814
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1814

def set_caret_line_visible_always(alwaysVisible) end

#set_caret_period(periodMilliseconds) ⇒ void Also known as: caret_period=

This method returns an undefined value.

Get the time in milliseconds that the caret is on and off.

0 = steady on.

Parameters:

  • periodMilliseconds (Integer) 


1676
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1676

def set_caret_period(periodMilliseconds) end

#set_caret_sticky(useCaretStickyBehaviour) ⇒ void Also known as: caret_sticky=

This method returns an undefined value.

Stop the caret preferred x position changing when the user types.

The input should be one of the wxSTC_CARETSTICKY_* constants.

Parameters:

  • useCaretStickyBehaviour (Integer) 


1773
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1773

def set_caret_sticky(useCaretStickyBehaviour) end

#set_caret_style(caretStyle) ⇒ void Also known as: caret_style=

This method returns an undefined value.

Set the style of the caret to be drawn.

The input should be one of the wxSTC_CARETSTYLE_* constants.

Parameters:

  • caretStyle (Integer) 


1796
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1796

def set_caret_style(caretStyle) end

#set_caret_width(pixelWidth) ⇒ void Also known as: caret_width=

This method returns an undefined value.

Set the width of the insert mode caret.

Parameters:

  • pixelWidth (Integer) 


1709
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1709

def set_caret_width(pixelWidth) end

#set_character_category_optimization(countCharacters) ⇒ void Also known as: character_category_optimization=

This method returns an undefined value.

Set the number of characters to have directly indexed categories.

Parameters:

  • countCharacters (Integer) 


2155
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2155

def set_character_category_optimization(countCharacters) end

#set_chars_default ⇒ void

This method returns an undefined value.

Reset the set of characters for whitespace and word characters to the defaults.



1387
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1387

def set_chars_default; end

#set_code_page(codePage) ⇒ void Also known as: code_page=

This method returns an undefined value.

Set the code page used to interpret the bytes of the document as characters.

Parameters:

  • codePage (Integer) 


2134
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2134

def set_code_page(codePage) end

#set_command_events(commandEvents) ⇒ void Also known as: command_events=

This method returns an undefined value.

Set whether command events are sent to the container.

Parameters:

  • commandEvents (Boolean) 


2305
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2305

def set_command_events(commandEvents) end

#set_control_char_symbol(symbol) ⇒ void Also known as: control_char_symbol=

This method returns an undefined value.

Change the way control characters are displayed: If symbol is < 32, keep the drawn way, else, use the given character.

Parameters:

  • symbol (Integer) 


1820
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1820

def set_control_char_symbol(symbol) end

#set_current_pos(caret) ⇒ void Also known as: current_pos=

This method returns an undefined value.

Sets the position of the caret.

Parameters:

  • caret (Integer) 


544
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 544

def set_current_pos(caret) end

#set_default_fold_display_text(text) ⇒ void Also known as: default_fold_display_text=

This method returns an undefined value.

Set the default fold display text.

Parameters:

  • text (String) 


2218
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2218

def set_default_fold_display_text(text) end

#set_default_style(style) ⇒ Boolean Also known as: default_style=

This method is inherited from TextAreaBase but is not implemented in Wx::STC::StyledTextCtrl.

Parameters:

Returns:

  • (Boolean) 


4403
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4403

def set_default_style(style) end

#set_edge_colour(edgeColour) ⇒ void Also known as: edge_colour=

This method returns an undefined value.

Change the colour used in edge indication.

Parameters:



3895
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3895

def set_edge_colour(edgeColour) end

#set_edge_column(column) ⇒ void Also known as: edge_column=

This method returns an undefined value.

Set the column number of the edge.

If text goes past the edge then it is highlighted.

Parameters:

  • column (Integer) 


3869
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3869

def set_edge_column(column) end

#set_edge_mode(edgeMode) ⇒ void Also known as: edge_mode=

This method returns an undefined value.

The edge may be displayed by a line (Wx::STC::STC_EDGE_LINE/Wx::STC::STC_EDGE_MULTILINE) or by highlighting text that goes beyond it (Wx::STC::STC_EDGE_BACKGROUND) or not displayed at all (Wx::STC::STC_EDGE_NONE).

The input should be one of the wxSTC_EDGE_* constants.

Parameters:

  • edgeMode (Integer) 


3884
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3884

def set_edge_mode(edgeMode) end

#set_editable(editable) ⇒ void Also known as: editable=

This method returns an undefined value.

Makes the text item editable or read-only, overriding the TE_READONLY flag.

Parameters:

  • editable (Boolean) —

    If true, the control is editable. If false, the control is read-only.

See Also:



4336
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4336

def set_editable(editable) end

#set_empty_selection(caret) ⇒ void Also known as: empty_selection=

This method returns an undefined value.

Set caret to a position, while removing any existing selection.

Parameters:

  • caret (Integer) 


572
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 572

def set_empty_selection(caret) end

#set_end_at_last_line(endAtLastLine) ⇒ void Also known as: end_at_last_line=

This method returns an undefined value.

Sets the scroll range so that maximum scroll position has the last line at the bottom of the view (default).

Setting this to false allows scrolling one page below the last line.

Parameters:

  • endAtLastLine (Boolean) 


1099
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1099

def set_end_at_last_line(endAtLastLine) end

#set_eol_mode(eolMode) ⇒ void Also known as: eol_mode=

This method returns an undefined value.

Set the current end of line mode.

The input should be one of the wxSTC_EOL_* constants.

Parameters:

  • eolMode (Integer) 


1284
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1284

def set_eol_mode(eolMode) end

#set_extra_ascent(extraAscent) ⇒ void Also known as: extra_ascent=

This method returns an undefined value.

Set extra ascent for each line.

Parameters:

  • extraAscent (Integer) 


1215
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1215

def set_extra_ascent(extraAscent) end

#set_extra_descent(extraDescent) ⇒ void Also known as: extra_descent=

This method returns an undefined value.

Set extra descent for each line.

Parameters:

  • extraDescent (Integer) 


1226
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1226

def set_extra_descent(extraDescent) end

#set_first_visible_line(displayLine) ⇒ void Also known as: first_visible_line=

This method returns an undefined value.

Scroll so that a display line is at the top of the display.

Parameters:

  • displayLine (Integer) 


1121
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1121

def set_first_visible_line(displayLine) end

#set_fold_expanded(line, expanded) ⇒ void

This method returns an undefined value.

Show the children of a header line.

Parameters:

  • line (Integer)
  • expanded (Boolean) 


3634
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3634

def set_fold_expanded(line, expanded) end

#set_fold_flags(flags) ⇒ void Also known as: fold_flags=

This method returns an undefined value.

Set some style options for folding.

The second argument should be a bit list containing one or more of the wxSTC_FOLDFLAG_* constants.

Parameters:

  • flags (Integer) 


3716
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3716

def set_fold_flags(flags) end

#set_fold_level(line, level) ⇒ void

This method returns an undefined value.

Set the fold level of a line.

This encodes an integer level along with flags indicating whether the line is a header and whether it is effectively white space.

Parameters:

  • line (Integer)
  • level (Integer) 


3586
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3586

def set_fold_level(line, level) end

#set_fold_margin_colour(useSetting, back) ⇒ void

This method returns an undefined value.

Set one of the colours used as a chequerboard pattern in the fold margin.

Parameters:

  • useSetting (Boolean)
  • back (Wx::Colour, String, Symbol) 


1964
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1964

def set_fold_margin_colour(useSetting, back) end

#set_fold_margin_hi_colour(useSetting, fore) ⇒ void

This method returns an undefined value.

Set the other colour used as a chequerboard pattern in the fold margin.

Parameters:

  • useSetting (Boolean)
  • fore (Wx::Colour, String, Symbol) 


1970
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1970

def set_fold_margin_hi_colour(useSetting, fore) end

#set_font_quality(fontQuality) ⇒ void Also known as: font_quality=

This method returns an undefined value.

Choose the quality level for text.

The input should be one of the wxSTC_EFF_QUALITY_* constants. <div class=“wxrb-remark”> Remark: <p>This method only has any effect with the WXMSW port and when technology has been set to Wx::STC::STC_TECHNOLOGY_DIRECTWRITE. </p> </div>

Parameters:

  • fontQuality (Integer) 


2260
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2260

def set_font_quality(fontQuality) end

#set_h_scroll_bar(bar) ⇒ void Also known as: h_scroll_bar=

This method returns an undefined value.

Set the horizontal scrollbar to use instead of the one that’s built-in.

Parameters:



4170
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4170

def set_h_scroll_bar(bar) end

#set_highlight_guide(column) ⇒ void Also known as: highlight_guide=

This method returns an undefined value.

Set the highlighted indentation guide column.

0 = no highlighted guide.

Parameters:

  • column (Integer) 


2564
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2564

def set_highlight_guide(column) end

#set_hotspot_active_background(useSetting, back) ⇒ void

This method returns an undefined value.

Set a back colour for active hotspots.

Parameters:

  • useSetting (Boolean)
  • back (Wx::Colour, String, Symbol) 


1732
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1732

def set_hotspot_active_background(useSetting, back) end

#set_hotspot_active_foreground(useSetting, fore) ⇒ void

This method returns an undefined value.

Set a fore colour for active hotspots.

Parameters:

  • useSetting (Boolean)
  • fore (Wx::Colour, String, Symbol) 


1721
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1721

def set_hotspot_active_foreground(useSetting, fore) end

#set_hotspot_active_underline(underline) ⇒ void Also known as: hotspot_active_underline=

This method returns an undefined value.

Enable / Disable underlining active hotspots.

Parameters:

  • underline (Boolean) 


1742
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1742

def set_hotspot_active_underline(underline) end

#set_hotspot_single_line(singleLine) ⇒ void Also known as: hotspot_single_line=

This method returns an undefined value.

Limit hotspots to single line so hotspots on two lines don’t merge.

Parameters:

  • singleLine (Boolean) 


1753
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1753

def set_hotspot_single_line(singleLine) end

#set_i_lexer(ilexer) ⇒ void Also known as: i_lexer=

This method returns an undefined value.

Set the lexer from an ILexer*.

Parameters:



2441
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2441

def set_i_lexer(ilexer) end

#set_identifier(identifier) ⇒ void Also known as: identifier=

This method returns an undefined value.

Set the identifier reported as idFrom in notification messages.

Parameters:

  • identifier (Integer) 


4084
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4084

def set_identifier(identifier) end

#set_identifiers(style, identifiers) ⇒ void

This method returns an undefined value.

Set the identifiers that are shown in a particular style.

Parameters:

  • style (Integer)
  • identifiers (String) 


4040
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4040

def set_identifiers(style, identifiers) end

#set_idle_styling(idleStyling) ⇒ void Also known as: idle_styling=

This method returns an undefined value.

Sets limits to idle styling.

The input should be one of the wxSTC_IDLESTYLING_* constants.

Parameters:

  • idleStyling (Integer) 


1427
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1427

def set_idle_styling(idleStyling) end

#set_ime_interaction(imeInteraction) ⇒ void Also known as: ime_interaction=

This method returns an undefined value.

Choose to display the IME in a window or inline.

The input should be one of the wxSTC_IME_* constants.

Parameters:

  • imeInteraction (Integer) 


2149
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2149

def set_ime_interaction(imeInteraction) end

#set_indent(indentSize) ⇒ void Also known as: indent=

This method returns an undefined value.

Set the number of spaces used for one level of indentation.

Parameters:

  • indentSize (Integer) 


2507
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2507

def set_indent(indentSize) end

#set_indentation_guides(indentView) ⇒ void Also known as: indentation_guides=

This method returns an undefined value.

Show or hide indentation guides.

The input should be one of the wxSTC_IV_* constants.

Parameters:

  • indentView (Integer) 


2549
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2549

def set_indentation_guides(indentView) end

#set_indicator_current(indicator) ⇒ void Also known as: indicator_current=

This method returns an undefined value.

Set the indicator used for IndicatorFillRange and IndicatorClearRange.

Parameters:

  • indicator (Integer) 


2785
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2785

def set_indicator_current(indicator) end

#set_indicator_value(value) ⇒ void Also known as: indicator_value=

This method returns an undefined value.

Set the value used for IndicatorFillRange.

Parameters:

  • value (Integer) 


2796
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2796

def set_indicator_value(value) end

#set_insertion_point(pos) ⇒ void Also known as: insertion_point=

This method returns an undefined value.

Sets the insertion point at the given position.

Parameters:



4274
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4274

def set_insertion_point(pos) end

#set_key_words(keyWordSet, keyWords) ⇒ void

This method returns an undefined value.

Set up the key words used by the lexer.

Parameters:

  • keyWordSet (Integer)
  • keyWords (String) 


3945
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3945

def set_key_words(keyWordSet, keyWords) end

#set_last_keydown_processed(val) ⇒ void Also known as: last_keydown_processed=

This method returns an undefined value.

Returns the line number of the line with the caret.

Parameters:

  • val (Boolean) 


4181
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4181

def set_last_keydown_processed(val) end

#set_layout_cache(cacheMode) ⇒ void Also known as: layout_cache=

This method returns an undefined value.

Sets the degree of caching of layout information.

The input should be one of the wxSTC_CACHE_* constants.

Parameters:

  • cacheMode (Integer) 


2231
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2231

def set_layout_cache(cacheMode) end

#set_lexer(lexer) ⇒ void Also known as: lexer=

This method returns an undefined value.

Set the lexing language of the document.

The input should be one of the wxSTC_LEX_* constants.

Parameters:

  • lexer (Integer) 


3919
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3919

def set_lexer(lexer) end

#set_lexer_language(language) ⇒ void Also known as: lexer_language=

This method returns an undefined value.

Set the lexing language of the document based on string name.

Parameters:

  • language (String) 


3950
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3950

def set_lexer_language(language) end

#set_line_end_types_allowed(lineEndBitSet) ⇒ void Also known as: line_end_types_allowed=

This method returns an undefined value.

Set the line end types that the application wants to use.

May not be used if incompatible with lexer or encoding. The input should be one of the wxSTC_LINE_END_TYPE_* constants.

Parameters:

  • lineEndBitSet (Integer) 


1304
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1304

def set_line_end_types_allowed(lineEndBitSet) end

#set_line_indentation(line, indentation) ⇒ void

This method returns an undefined value.

Change the indentation of a line to a number of columns.

Parameters:

  • line (Integer)
  • indentation (Integer) 


2530
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2530

def set_line_indentation(line, indentation) end

#set_line_state(line, state) ⇒ void

This method returns an undefined value.

Used to hold extra styling information for each line.

Parameters:

  • line (Integer)
  • state (Integer) 


1409
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1409

def set_line_state(line, state) end

#set_main_selection(selection) ⇒ void Also known as: main_selection=

This method returns an undefined value.

Set the main selection.

Parameters:

  • selection (Integer) 


826
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 826

def set_main_selection(selection) end

#set_margin_background(margin, back) ⇒ void

This method returns an undefined value.

Set the background colour of a margin.

Only visible for Wx::STC::STC_MARGIN_COLOUR.

Parameters:

  • margin (Integer)
  • back (Wx::Colour, String, Symbol) 


1919
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1919

def set_margin_background(margin, back) end

#set_margin_count(margins) ⇒ void Also known as: margin_count=

This method returns an undefined value.

Allocate a non-standard number of margins.

Parameters:

  • margins (Integer) 


1930
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1930

def set_margin_count(margins) end

#set_margin_cursor(margin, cursor) ⇒ void

This method returns an undefined value.

Set the cursor shown when the mouse is inside a margin.

The second argument should be one of the wxSTC_CURSOR* constants.

Parameters:

  • margin (Integer)
  • cursor (Integer) 


1903
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1903

def set_margin_cursor(margin, cursor) end

#set_margin_left(pixelWidth) ⇒ void Also known as: margin_left=

This method returns an undefined value.

Sets the size in pixels of the left margin.

Parameters:

  • pixelWidth (Integer) 


1941
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1941

def set_margin_left(pixelWidth) end

#set_margin_mask(margin, mask) ⇒ void

This method returns an undefined value.

Set a mask that determines which markers are displayed in a margin.

Parameters:

  • margin (Integer)
  • mask (Integer) 


1877
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1877

def set_margin_mask(margin, mask) end

#set_margin_options(marginOptions) ⇒ void Also known as: margin_options=

This method returns an undefined value.

Set the margin options.

The input should be one of the wxSTC_MARGINOPTION_* constants.

Parameters:

  • marginOptions (Integer) 


2023
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2023

def set_margin_options(marginOptions) end

#set_margin_right(pixelWidth) ⇒ void Also known as: margin_right=

This method returns an undefined value.

Sets the size in pixels of the right margin.

Parameters:

  • pixelWidth (Integer) 


1952
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1952

def set_margin_right(pixelWidth) end

#set_margin_sensitive(margin, sensitive) ⇒ void

This method returns an undefined value.

Make a margin sensitive or insensitive to mouse clicks.

Parameters:

  • margin (Integer)
  • sensitive (Boolean) 


1889
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1889

def set_margin_sensitive(margin, sensitive) end

#set_margin_type(margin, marginType) ⇒ void

This method returns an undefined value.

Set a margin to be either numeric or symbolic.

The second argument should be one of the wxSTC_MARGIN_* constants.

Parameters:

  • margin (Integer)
  • marginType (Integer) 


1851
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1851

def set_margin_type(margin, marginType) end

#set_margin_width(margin, pixelWidth) ⇒ void

This method returns an undefined value.

Set the width of a margin to a width expressed in pixels.

Parameters:

  • margin (Integer)
  • pixelWidth (Integer) 


1865
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1865

def set_margin_width(margin, pixelWidth) end

#set_margins(left, right) ⇒ void

This method returns an undefined value.

Set the left and right margin in the edit area, measured in pixels.

Parameters:

  • left (Integer)
  • right (Integer) 


4142
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4142

def set_margins(left, right) end

#set_mod_event_mask(eventMask) ⇒ void Also known as: mod_event_mask=

This method returns an undefined value.

Set which document modification events are sent to the container.

The input should be a bit list containing one or more of the wxSTC_MOD* constants, the wxSTC_PERFORMED* constants, Wx::STC::STC_STARTACTION, Wx::STC::STC_MULTILINEUNDOREDO, Wx::STC::STC_MULTISTEPUNDOREDO, and Wx::STC::STC_LASTSTEPINUNDOREDO. The input can also be Wx::STC::STC_MODEVENTMASKALL to indicate that all changes should generate events.

Parameters:

  • eventMask (Integer) 


4071
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4071

def set_mod_event_mask(eventMask) end

#set_mouse_down_captures(captures) ⇒ void Also known as: mouse_down_captures=

This method returns an undefined value.

Set whether the mouse is captured when its button is pressed.

Parameters:

  • captures (Boolean) 


1250
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1250

def set_mouse_down_captures(captures) end

#set_mouse_dwell_time(periodMilliseconds) ⇒ void Also known as: mouse_dwell_time=

This method returns an undefined value.

Sets the time the mouse must sit still to generate a mouse dwell event.

The input should be a time in milliseconds or Wx::STC::STC_TIME_FOREVER.

Parameters:

  • periodMilliseconds (Integer) 


4056
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4056

def set_mouse_dwell_time(periodMilliseconds) end

#set_mouse_selection_rectangular_switch(mouseSelectionRectangularSwitch) ⇒ void Also known as: mouse_selection_rectangular_switch=

This method returns an undefined value.

Set whether switching to rectangular mode while selecting with the mouse is allowed.

Parameters:

  • mouseSelectionRectangularSwitch (Boolean) 


723
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 723

def set_mouse_selection_rectangular_switch(mouseSelectionRectangularSwitch) end

#set_mouse_wheel_captures(captures) ⇒ void Also known as: mouse_wheel_captures=

This method returns an undefined value.

Set whether the mouse wheel can be active outside the window.

Parameters:

  • captures (Boolean) 


1261
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1261

def set_mouse_wheel_captures(captures) end

#set_multi_paste(multiPaste) ⇒ void Also known as: multi_paste=

This method returns an undefined value.

Change the effect of pasting when there are multiple selections.

The input should be one of the wxSTC_MULTIPASTE_* constants.

Parameters:

  • multiPaste (Integer) 


744
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 744

def set_multi_paste(multiPaste) end

#set_multiple_selection(multipleSelection) ⇒ void Also known as: multiple_selection=

This method returns an undefined value.

Set whether multiple selections can be made.

Parameters:

  • multipleSelection (Boolean) 


757
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 757

def set_multiple_selection(multipleSelection) end

#set_overtype(overType) ⇒ void Also known as: overtype=

This method returns an undefined value.

Set to overtype (true) or insert mode.

Parameters:

  • overType (Boolean) 


344
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 344

def set_overtype(overType) end

#set_paste_convert_endings(convert) ⇒ void Also known as: paste_convert_endings=

This method returns an undefined value.

Enable/Disable convert-on-paste for line endings.

Parameters:

  • convert (Boolean) 


390
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 390

def set_paste_convert_endings(convert) end

#set_phases_draw(phases) ⇒ void Also known as: phases_draw=

This method returns an undefined value.

In one phase draw, text is drawn in a series of rectangular blocks with no overlap.

In two phase draw, text is drawn in a series of lines allowing runs to overlap horizontally. In multiple phase draw, each element is drawn over the whole drawing area, allowing text to overlap from one line to the next. The input should be one of the wxSTC_PHASES_* constants.

Parameters:

  • phases (Integer) 


2247
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2247

def set_phases_draw(phases) end

#set_position_cache_size(size) ⇒ void Also known as: position_cache_size=

This method returns an undefined value.

Set number of entries in position cache.

Parameters:

  • size (Integer) 


3830
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3830

def set_position_cache_size(size) end

#set_print_colour_mode(mode) ⇒ void Also known as: print_colour_mode=

This method returns an undefined value.

Modify colours when printing for clearer printed text.

The input should be one of the wxSTC_PRINT_* constants.

Parameters:

  • mode (Integer) 


3531
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3531

def set_print_colour_mode(mode) end

#set_print_magnification(magnification) ⇒ void Also known as: print_magnification=

This method returns an undefined value.

Sets the print magnification added to the point size of each style for printing.

Parameters:

  • magnification (Integer) 


3518
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3518

def set_print_magnification(magnification) end

#set_print_wrap_mode(wrapMode) ⇒ void Also known as: print_wrap_mode=

This method returns an undefined value.

Set printing to line wrapped (Wx::STC::STC_WRAP_WORD) or not line wrapped (Wx::STC::STC_WRAP_NONE).

Parameters:

  • wrapMode (Integer) 


3555
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3555

def set_print_wrap_mode(wrapMode) end

#set_property(key, value) ⇒ void

This method returns an undefined value.

Set up a value that may be used by a lexer for some optional feature.

Parameters:

  • key (String)
  • value (String) 


3939
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3939

def set_property(key, value) end

#set_punctuation_chars(characters) ⇒ void Also known as: punctuation_chars=

This method returns an undefined value.

Set the set of characters making up punctuation characters Should be called after SetWordChars.

Parameters:

  • characters (String) 


1377
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1377

def set_punctuation_chars(characters) end

#set_read_only(readOnly) ⇒ void Also known as: read_only=

This method returns an undefined value.

Set to read only or read write.

Parameters:

  • readOnly (Boolean) 


189
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 189

def set_read_only(readOnly) end

#set_rectangular_selection_anchor(anchor) ⇒ void Also known as: rectangular_selection_anchor=

This method returns an undefined value.

Set the anchor position of the rectangular selection.

Parameters:

  • anchor (Integer) 


920
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 920

def set_rectangular_selection_anchor(anchor) end

#set_rectangular_selection_anchor_virtual_space(space) ⇒ void Also known as: rectangular_selection_anchor_virtual_space=

This method returns an undefined value.

Set the virtual space of the anchor of the rectangular selection.

Parameters:

  • space (Integer) 


942
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 942

def set_rectangular_selection_anchor_virtual_space(space) end

#set_rectangular_selection_caret(caret) ⇒ void Also known as: rectangular_selection_caret=

This method returns an undefined value.

Set the caret position of the rectangular selection.

Parameters:

  • caret (Integer) 


909
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 909

def set_rectangular_selection_caret(caret) end

#set_rectangular_selection_caret_virtual_space(space) ⇒ void Also known as: rectangular_selection_caret_virtual_space=

This method returns an undefined value.

Set the virtual space of the caret of the rectangular selection.

Parameters:

  • space (Integer) 


931
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 931

def set_rectangular_selection_caret_virtual_space(space) end

#set_rectangular_selection_modifier(modifier) ⇒ void Also known as: rectangular_selection_modifier=

This method returns an undefined value.

On GTK, allow selecting the modifier key to use for mouse-based rectangular selection.

Often the window manager requires Alt+Mouse Drag for moving windows. Valid values are Wx::STC::STC_KEYMOD_CTRL (default), Wx::STC::STC_KEYMOD_ALT, or Wx::STC::STC_KEYMOD_SUPER.

Parameters:

  • modifier (Integer) 


970
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 970

def set_rectangular_selection_modifier(modifier) end

#set_representation(encodedCharacter, representation) ⇒ void

This method returns an undefined value.

Set the way a character is drawn.

Parameters:

  • encodedCharacter (String)
  • representation (String) 


1832
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1832

def set_representation(encodedCharacter, representation) end

#set_save_point ⇒ void

This method returns an undefined value.

Remember the current position in the undo history as the position at which the document was saved.



161
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 161

def set_save_point; end

#set_scroll_width(pixelWidth) ⇒ void Also known as: scroll_width=

This method returns an undefined value.

Sets the document width assumed for scrolling.

Parameters:

  • pixelWidth (Integer) 


1075
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1075

def set_scroll_width(pixelWidth) end

#set_scroll_width_tracking(tracking) ⇒ void Also known as: scroll_width_tracking=

This method returns an undefined value.

Sets whether the maximum width line displayed is used to set scroll width.

Parameters:

  • tracking (Boolean) 


1086
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1086

def set_scroll_width_tracking(tracking) end

#set_search_flags(searchFlags) ⇒ void Also known as: search_flags=

This method returns an undefined value.

Set the search flags used by SearchInTarget.

The input should be a bit list containing one or more of the wxSTC_FIND_* constants.

Parameters:

  • searchFlags (Integer) 


305
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 305

def set_search_flags(searchFlags) end

#set_sel_alpha(alpha) ⇒ void Also known as: sel_alpha=

This method returns an undefined value.

Set the alpha of the selection.

Parameters:

  • alpha (Integer) 


1646
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1646

def set_sel_alpha(alpha) end

#set_sel_background(useSetting, back) ⇒ void

This method returns an undefined value.

Set the background colour of the main and additional selections and whether to use this setting.

Parameters:

  • useSetting (Boolean)
  • back (Wx::Colour, String, Symbol) 


1636
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1636

def set_sel_background(useSetting, back) end

#set_sel_eol_filled(filled) ⇒ void Also known as: sel_eol_filled=

This method returns an undefined value.

Set the selection to have its end of line filled or not.

Parameters:

  • filled (Boolean) 


1657
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1657

def set_sel_eol_filled(filled) end

#set_sel_foreground(useSetting, fore) ⇒ void

This method returns an undefined value.

Set the foreground colour of the main and additional selections and whether to use this setting.

Parameters:

  • useSetting (Boolean)
  • fore (Wx::Colour, String, Symbol) 


1630
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1630

def set_sel_foreground(useSetting, fore) end

#set_selection(from, to) ⇒ void

This method returns an undefined value.

Selects the text starting at the first position up to (but not including) the character at the last position.

If both parameters are equal to -1 all text in the control is selected. Notice that the insertion point will be moved to from by this function.

Parameters:

  • from (Integer) —

    The first position.

  • to (Integer) —

    The last position.

See Also:



4310
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4310

def set_selection(from, to) end

#set_selection_end(caret) ⇒ void Also known as: selection_end=

This method returns an undefined value.

Sets the position that ends the selection - this becomes the caret.

Parameters:

  • caret (Integer) 


561
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 561

def set_selection_end(caret) end

#set_selection_mode(selectionMode) ⇒ void Also known as: selection_mode=

This method returns an undefined value.

Set the selection mode to stream (Wx::STC::STC_SEL_STREAM) or rectangular (Wx::STC::STC_SEL_RECTANGLE/Wx::STC::STC_SEL_THIN) or by lines (Wx::STC::STC_SEL_LINES).

Parameters:

  • selectionMode (Integer) 


676
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 676

def set_selection_mode(selectionMode) end

#set_selection_n_anchor(selection, anchor) ⇒ void

This method returns an undefined value.

Set the anchor position of the nth selection.

Parameters:

  • selection (Integer)
  • anchor (Integer) 


850
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 850

def set_selection_n_anchor(selection, anchor) end

#set_selection_n_anchor_virtual_space(selection, space) ⇒ void

This method returns an undefined value.

Set the virtual space of the anchor of the nth selection.

Parameters:

  • selection (Integer)
  • space (Integer) 


874
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 874

def set_selection_n_anchor_virtual_space(selection, space) end

#set_selection_n_caret(selection, caret) ⇒ void

This method returns an undefined value.

Set the caret position of the nth selection.

Parameters:

  • selection (Integer)
  • caret (Integer) 


838
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 838

def set_selection_n_caret(selection, caret) end

#set_selection_n_caret_virtual_space(selection, space) ⇒ void

This method returns an undefined value.

Set the virtual space of the caret of the nth selection.

Parameters:

  • selection (Integer)
  • space (Integer) 


862
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 862

def set_selection_n_caret_virtual_space(selection, space) end

#set_selection_n_end(selection, caret) ⇒ void

This method returns an undefined value.

Sets the position that ends the selection - this becomes the currentPosition.

Parameters:

  • selection (Integer)
  • caret (Integer) 


898
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 898

def set_selection_n_end(selection, caret) end

#set_selection_n_start(selection, anchor) ⇒ void

This method returns an undefined value.

Sets the position that starts the selection - this becomes the anchor.

Parameters:

  • selection (Integer)
  • anchor (Integer) 


886
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 886

def set_selection_n_start(selection, anchor) end

#set_selection_start(anchor) ⇒ void Also known as: selection_start=

This method returns an undefined value.

Sets the position that starts the selection - this becomes the anchor.

Parameters:

  • anchor (Integer) 


550
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 550

def set_selection_start(anchor) end

#set_status(status) ⇒ void Also known as: status=

This method returns an undefined value.

Change error status - 0 = OK.

The input should be one of the wxSTC_STATUS_* constants.

Parameters:

  • status (Integer) 


407
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 407

def set_status(status) end

#set_stc_cursor(cursorType) ⇒ void Also known as: stc_cursor=

This method returns an undefined value.

Sets the cursor to one of the Wx::STC_CURSOR* values.

Parameters:

  • cursorType (Integer) 


1237
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1237

def set_stc_cursor(cursorType) end

#set_stc_focus(focus) ⇒ void Also known as: stc_focus=

This method returns an undefined value.

Change internal focus flag.

Parameters:

  • focus (Boolean) 


2316
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2316

def set_stc_focus(focus) end

#set_style(start, end_, style) ⇒ Boolean

This method is inherited from TextAreaBase but is not implemented in Wx::STC::StyledTextCtrl.

Parameters:

Returns:

  • (Boolean) 


4391
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4391

def set_style(start, end_, style) end

#set_styling(length, style) ⇒ void

This method returns an undefined value.

Change style from current styling position for length characters to a style and move the current styling position to after this newly styled segment.

Parameters:

  • length (Integer)
  • style (Integer) 


1403
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1403

def set_styling(length, style) end

#set_tab_draw_mode(tabDrawMode) ⇒ void Also known as: tab_draw_mode=

This method returns an undefined value.

Set how tabs are drawn when visible.

The input should be one of the wxSTC_TD_* constants.

Parameters:

  • tabDrawMode (Integer) 


1186
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1186

def set_tab_draw_mode(tabDrawMode) end

#set_tab_indents(tabIndents) ⇒ void Also known as: tab_indents=

This method returns an undefined value.

Sets whether a tab pressed when caret is within indentation indents.

Parameters:

  • tabIndents (Boolean) 


2575
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2575

def set_tab_indents(tabIndents) end

#set_tab_minimum_width(pixels) ⇒ void Also known as: tab_minimum_width=

This method returns an undefined value.

Set the minimum visual width of a tab.

Parameters:

  • pixels (Integer) 


2123
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2123

def set_tab_minimum_width(pixels) end

#set_tab_width(tabWidth) ⇒ void Also known as: tab_width=

This method returns an undefined value.

Change the visible size of a tab to be a multiple of the width of a space character.

Parameters:

  • tabWidth (Integer) 


2478
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2478

def set_tab_width(tabWidth) end

#set_target_end(end_) ⇒ void Also known as: target_end=

This method returns an undefined value.

Sets the position that ends the target which is used for updating the document without affecting the scroll position.

Parameters:

  • end_ (Integer) 


252
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 252

def set_target_end(end_) end

#set_target_end_virtual_space(space) ⇒ void Also known as: target_end_virtual_space=

This method returns an undefined value.

Sets the virtual space of the target end.

Parameters:

  • space (Integer) 


2203
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2203

def set_target_end_virtual_space(space) end

#set_target_range(start, end_) ⇒ void

This method returns an undefined value.

Sets both the start and end of the target in one call.

Parameters:

  • start (Integer)
  • end_ (Integer) 


264
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 264

def set_target_range(start, end_) end

#set_target_start(start) ⇒ void Also known as: target_start=

This method returns an undefined value.

Sets the position that starts the target which is used for updating the document without affecting the scroll position.

Parameters:

  • start (Integer) 


241
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 241

def set_target_start(start) end

#set_target_start_virtual_space(space) ⇒ void Also known as: target_start_virtual_space=

This method returns an undefined value.

Sets the virtual space of the target start.

Parameters:

  • space (Integer) 


2192
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2192

def set_target_start_virtual_space(space) end

#set_technology(technology) ⇒ void Also known as: technology=

This method returns an undefined value.

Set the technology used.

Remark:

For the WXMSW port, the input can be either Wx::STC::STC_TECHNOLOGY_DEFAULT or Wx::STC::STC_TECHNOLOGY_DIRECTWRITE. With other ports, this method has no effect.

Parameters:

  • technology (Integer) 


2358
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2358

def set_technology(technology) end

#set_text(text) ⇒ void Also known as: text=

This method returns an undefined value.

Replace the contents of the document with the argument text.

Parameters:

  • text (String) 


195
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 195

def set_text(text) end

#set_undo_collection(collectUndo) ⇒ void Also known as: undo_collection=

This method returns an undefined value.

Choose between collecting actions into the undo history and discarding them.

Parameters:

  • collectUndo (Boolean) 


424
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 424

def set_undo_collection(collectUndo) end

#set_use_anti_aliasing(useAA) ⇒ void Also known as: use_anti_aliasing=

This method returns an undefined value.

Specify whether anti-aliased fonts should be used.

This will have no effect on some platforms, but on some (WXOSX for example) can greatly improve performance.

Parameters:

  • useAA (Boolean) 


4224
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4224

def set_use_anti_aliasing(useAA) end

#set_use_horizontal_scroll_bar(visible) ⇒ void Also known as: use_horizontal_scroll_bar=

This method returns an undefined value.

Show or hide the horizontal scroll bar.

Parameters:

  • visible (Boolean) 


1041
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1041

def set_use_horizontal_scroll_bar(visible) end

#set_use_tabs(useTabs) ⇒ void Also known as: use_tabs=

This method returns an undefined value.

Indentation will only use space characters if useTabs is false, otherwise it will use a combination of tabs and spaces.

Parameters:

  • useTabs (Boolean) 


2518
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2518

def set_use_tabs(useTabs) end

#set_use_vertical_scroll_bar(visible) ⇒ void Also known as: use_vertical_scroll_bar=

This method returns an undefined value.

Show or hide the vertical scroll bar.

Parameters:

  • visible (Boolean) 


1110
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1110

def set_use_vertical_scroll_bar(visible) end

#set_v_scroll_bar(bar) ⇒ void Also known as: v_scroll_bar=

This method returns an undefined value.

Set the vertical scrollbar to use instead of the one that’s built-in.

Parameters:



4164
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4164

def set_v_scroll_bar(bar) end

#set_view_eol(visible) ⇒ void Also known as: view_eol=

This method returns an undefined value.

Make the end of line characters visible or invisible.

Parameters:

  • visible (Boolean) 


1295
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1295

def set_view_eol(visible) end

#set_view_white_space(viewWS) ⇒ void Also known as: view_white_space=

This method returns an undefined value.

Make white space characters invisible, always visible or visible outside indentation.

The input should be one of the wxSTC_WS_* constants.

Parameters:

  • viewWS (Integer) 


1171
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1171

def set_view_white_space(viewWS) end

#set_virtual_space_options(virtualSpaceOptions) ⇒ void Also known as: virtual_space_options=

This method returns an undefined value.

Set options for virtual space behaviour.

The input should be one of the wxSTC_VS_* constants.

Parameters:

  • virtualSpaceOptions (Integer) 


955
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 955

def set_virtual_space_options(virtualSpaceOptions) end

#set_visible_policy(visiblePolicy, visibleSlop) ⇒ void

This method returns an undefined value.

Set the way the display area is determined when a particular line is to be moved to by Find, FindNext, GotoLine, etc.

The first argument should be a bit list containing one or more of the wxSTC_VISIBLE_* constants.

Parameters:

  • visiblePolicy (Integer)
  • visibleSlop (Integer) 


1130
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1130

def set_visible_policy(visiblePolicy, visibleSlop) end

#set_whitespace_background(useSetting, back) ⇒ void

This method returns an undefined value.

Set the background colour of all whitespace and whether to use this setting.

Parameters:

  • useSetting (Boolean)
  • back (Wx::Colour, String, Symbol) 


1199
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1199

def set_whitespace_background(useSetting, back) end

#set_whitespace_chars(characters) ⇒ void Also known as: whitespace_chars=

This method returns an undefined value.

Set the set of characters making up whitespace for when moving or selecting by word.

Should be called after SetWordChars.

Parameters:

  • characters (String) 


1366
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1366

def set_whitespace_chars(characters) end

#set_whitespace_foreground(useSetting, fore) ⇒ void

This method returns an undefined value.

Set the foreground colour of all whitespace and whether to use this setting.

Parameters:

  • useSetting (Boolean)
  • fore (Wx::Colour, String, Symbol) 


1193
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1193

def set_whitespace_foreground(useSetting, fore) end

#set_whitespace_size(size) ⇒ void Also known as: whitespace_size=

This method returns an undefined value.

Set the size of the dots used to mark space characters.

Parameters:

  • size (Integer) 


1204
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1204

def set_whitespace_size(size) end

#set_word_chars(characters) ⇒ void Also known as: word_chars=

This method returns an undefined value.

Set the set of characters making up words for when moving or selecting by word.

First sets defaults like SetCharsDefault.

Parameters:

  • characters (String) 


1334
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1334

def set_word_chars(characters) end

#set_wrap_indent_mode(wrapIndentMode) ⇒ void Also known as: wrap_indent_mode=

This method returns an undefined value.

Sets how wrapped sublines are placed.

Default is Wx::STC::STC_WRAPINDENT_FIXED. The input should be one of the wxSTC_WRAPINDENT_* constants.

Parameters:

  • wrapIndentMode (Integer) 


3800
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3800

def set_wrap_indent_mode(wrapIndentMode) end

#set_wrap_mode(wrapMode) ⇒ void Also known as: wrap_mode=

This method returns an undefined value.

Sets whether text is word wrapped.

The input should be one of the wxSTC_WRAP_* constants.

Parameters:

  • wrapMode (Integer) 


3743
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3743

def set_wrap_mode(wrapMode) end

#set_wrap_start_indent(indent) ⇒ void Also known as: wrap_start_indent=

This method returns an undefined value.

Set the start indent for wrapped lines.

Parameters:

  • indent (Integer) 


3786
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3786

def set_wrap_start_indent(indent) end

#set_wrap_visual_flags(wrapVisualFlags) ⇒ void Also known as: wrap_visual_flags=

This method returns an undefined value.

Set the display mode of visual flags for wrapped lines.

The input should be a bit list containing one or more of the wxSTC_WRAPVISUALFLAG_* constants.

Parameters:

  • wrapVisualFlags (Integer) 


3758
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3758

def set_wrap_visual_flags(wrapVisualFlags) end

#set_wrap_visual_flags_location(wrapVisualFlagsLocation) ⇒ void Also known as: wrap_visual_flags_location=

This method returns an undefined value.

Set the location of visual flags for wrapped lines.

The input should be a bit list containing one or more of the wxSTC_WRAPVISUALFLAGLOC_* constants.

Parameters:

  • wrapVisualFlagsLocation (Integer) 


3773
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3773

def set_wrap_visual_flags_location(wrapVisualFlagsLocation) end

#set_x_caret_policy(caretPolicy, caretSlop) ⇒ void

This method returns an undefined value.

Set the way the caret is kept visible when going sideways.

The exclusion zone is given in pixels. The first argument should be a bit list containing one or more of the wxSTC_CARET_* constants.

Parameters:

  • caretPolicy (Integer)
  • caretSlop (Integer) 


1150
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1150

def set_x_caret_policy(caretPolicy, caretSlop) end

#set_x_offset(xOffset) ⇒ void Also known as: x_offset=

This method returns an undefined value.

Set the xOffset (ie, horizontal scroll position).

Parameters:

  • xOffset (Integer) 


1135
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1135

def set_x_offset(xOffset) end

#set_y_caret_policy(caretPolicy, caretSlop) ⇒ void

This method returns an undefined value.

Set the way the line the caret is on is kept visible.

The exclusion zone is given in lines. The first argument should be a bit list containing one or more of the wxSTC_CARET_* constants.

Parameters:

  • caretPolicy (Integer)
  • caretSlop (Integer) 


1159
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1159

def set_y_caret_policy(caretPolicy, caretSlop) end

#set_zoom(zoomInPoints) ⇒ void Also known as: zoom=

This method returns an undefined value.

Set the zoom level.

This number of points is added to the size of all fonts. It may be positive to magnify or negative to reduce.

Parameters:

  • zoomInPoints (Integer) 


3851
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3851

def set_zoom(zoomInPoints) end

#show_lines(lineStart, lineEnd) ⇒ void

This method returns an undefined value.

Make a range of lines visible.

Parameters:

  • lineStart (Integer)
  • lineEnd (Integer) 


3611
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3611

def show_lines(lineStart, lineEnd) end

#show_position(pos) ⇒ void

This method returns an undefined value.

Makes the line containing the given position visible.

Parameters:

  • pos (Integer) —

    The position that should be visible.



4425
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4425

def show_position(pos) end

#start_record ⇒ void

This method returns an undefined value.

Start notifying the container of all key presses and commands.



3509
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3509

def start_record; end

#start_styling(start) ⇒ void

This method returns an undefined value.

Set the current styling position to start.

Parameters:

  • start (Integer) 


1397
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1397

def start_styling(start) end

#stop_record ⇒ void

This method returns an undefined value.

Stop notifying the container of all key presses and commands.



3513
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3513

def stop_record; end

#stuttered_page_down ⇒ void

This method returns an undefined value.

Move caret to bottom of page, or one page down if already at bottom of page.



3424
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3424

def stuttered_page_down; end

#stuttered_page_down_extend ⇒ void

This method returns an undefined value.

Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.



3428
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3428

def stuttered_page_down_extend; end

#stuttered_page_up ⇒ void

This method returns an undefined value.

Move caret to top of page, or one page up if already at top of page.



3416
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3416

def stuttered_page_up; end

#stuttered_page_up_extend ⇒ void

This method returns an undefined value.

Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.



3420
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3420

def stuttered_page_up_extend; end

#style_clear_all ⇒ void

This method returns an undefined value.

Clear all the styles and make equivalent to the global default style.



1439
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1439

def style_clear_all; end

#style_get_background(style) ⇒ Wx::Colour

Get the background colour of a style.

Parameters:

  • style (Integer)

Returns:



1501
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1501

def style_get_background(style) end

#style_get_bold(style) ⇒ Boolean

Get is a style bold or not.

Parameters:

  • style (Integer)

Returns:

  • (Boolean) 


1506
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1506

def style_get_bold(style) end

#style_get_case(style) ⇒ Integer

Get is a style mixed case, or to force upper or lower case.

The return value will be one of the wxSTC_CASE_* constants.

Parameters:

  • style (Integer)

Returns:

  • (Integer) 


1538
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1538

def style_get_case(style) end

#style_get_changeable(style) ⇒ Boolean

Get is a style changeable or not (read only).

Experimental feature, currently buggy.

Parameters:

  • style (Integer)

Returns:

  • (Boolean) 


1555
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1555

def style_get_changeable(style) end

#style_get_character_set(style) ⇒ Integer

Get the character get of the font in a style.

Parameters:

  • style (Integer)

Returns:

  • (Integer) 


1543
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1543

def style_get_character_set(style) end

#style_get_eol_filled(style) ⇒ Boolean

Get is a style to have its end of line filled or not.

Parameters:

  • style (Integer)

Returns:

  • (Boolean) 


1526
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1526

def style_get_eol_filled(style) end

#style_get_face_name(style) ⇒ String

Get the font facename of a style.

Parameters:

  • style (Integer)

Returns:

  • (String) 


1521
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1521

def style_get_face_name(style) end

#style_get_font(style) ⇒ Wx::Font

Get the font of a style.

Parameters:

  • style (Integer)

Returns:



4108
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4108

def style_get_font(style) end

#style_get_foreground(style) ⇒ Wx::Colour

Get the foreground colour of a style.

Parameters:

  • style (Integer)

Returns:



1496
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1496

def style_get_foreground(style) end

#style_get_hot_spot(style) ⇒ Boolean

Get is a style a hotspot or not.

Parameters:

  • style (Integer)

Returns:

  • (Boolean) 


1560
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1560

def style_get_hot_spot(style) end

#style_get_italic(style) ⇒ Boolean

Get is a style italic or not.

Parameters:

  • style (Integer)

Returns:

  • (Boolean) 


1511
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1511

def style_get_italic(style) end

#style_get_size(style) ⇒ Integer

Get the size of characters of a style.

Parameters:

  • style (Integer)

Returns:

  • (Integer) 


1516
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1516

def style_get_size(style) end

#style_get_size_fractional(style) ⇒ Integer

Get the size of characters of a style in points multiplied by 100.

Parameters:

  • style (Integer)

Returns:

  • (Integer) 


1581
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1581

def style_get_size_fractional(style) end

#style_get_underline(style) ⇒ Boolean

Get is a style underlined or not.

Parameters:

  • style (Integer)

Returns:

  • (Boolean) 


1531
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1531

def style_get_underline(style) end

#style_get_visible(style) ⇒ Boolean

Get is a style visible or not.

Parameters:

  • style (Integer)

Returns:

  • (Boolean) 


1548
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1548

def style_get_visible(style) end

#style_get_weight(style) ⇒ Integer

Get the weight of characters of a style.

The return value will be an integer that is possibly one of the wxSTC_WEIGHT_* constants.

Parameters:

  • style (Integer)

Returns:

  • (Integer) 


1596
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1596

def style_get_weight(style) end

#style_reset_default ⇒ void

This method returns an undefined value.

Reset the default style to its state at startup.



1485
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1485

def style_reset_default; end

#style_set_background(style, back) ⇒ void

This method returns an undefined value.

Set the background colour of a style.

Parameters:

  • style (Integer)
  • back (Wx::Colour, String, Symbol) 


1451
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1451

def style_set_background(style, back) end

#style_set_bold(style, bold) ⇒ void

This method returns an undefined value.

Set a style to be bold or not.

Parameters:

  • style (Integer)
  • bold (Boolean) 


1457
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1457

def style_set_bold(style, bold) end

#style_set_case(style, caseVisible) ⇒ void

This method returns an undefined value.

Set a style to be mixed case, or to force upper or lower case.

The second argument should be one of the wxSTC_CASE_* constants.

Parameters:

  • style (Integer)
  • caseVisible (Integer) 


1568
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1568

def style_set_case(style, caseVisible) end

#style_set_changeable(style, changeable) ⇒ void

This method returns an undefined value.

Set a style to be changeable or not (read only).

Experimental feature, currently buggy.

Parameters:

  • style (Integer)
  • changeable (Boolean) 


1624
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1624

def style_set_changeable(style, changeable) end

#style_set_character_set(style, characterSet) ⇒ void

This method returns an undefined value.

Set the character set of the font in a style.

Converts the Scintilla character set values to a FontEncoding.

Parameters:

  • style (Integer)
  • characterSet (Integer) 


1604
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1604

def style_set_character_set(style, characterSet) end

#style_set_eol_filled(style, eolFilled) ⇒ void

This method returns an undefined value.

Set a style to have its end of line filled or not.

Parameters:

  • style (Integer)
  • eolFilled (Boolean) 


1481
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1481

def style_set_eol_filled(style, eolFilled) end

#style_set_face_name(style, fontName) ⇒ void

This method returns an undefined value.

Set the font of a style.

Parameters:

  • style (Integer)
  • fontName (String) 


1475
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1475

def style_set_face_name(style, fontName) end

#style_set_font(styleNum, font) ⇒ void

This method returns an undefined value.

Set style size, face, bold, italic, and underline attributes from a Font‘s attributes.

Parameters:



4114
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4114

def style_set_font(styleNum, font) end

#style_set_font_attr(styleNum, size, faceName, bold, italic, underline, encoding = Wx::FontEncoding::FONTENCODING_DEFAULT) ⇒ void

This method returns an undefined value.

Set all font style attributes at once.

Parameters:

  • styleNum (Integer)
  • size (Integer)
  • faceName (String)
  • bold (Boolean)
  • italic (Boolean)
  • underline (Boolean)
  • encoding (Wx::FontEncoding) (defaults to: Wx::FontEncoding::FONTENCODING_DEFAULT) 


4125
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4125

def style_set_font_attr(styleNum, size, faceName, bold, italic, underline, encoding=Wx::FontEncoding::FONTENCODING_DEFAULT) end

#style_set_font_encoding(style, encoding) ⇒ void

This method returns an undefined value.

Set the font encoding to be used by a style.

Parameters:



4131
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4131

def style_set_font_encoding(style, encoding) end

#style_set_foreground(style, fore) ⇒ void

This method returns an undefined value.

Set the foreground colour of a style.

Parameters:

  • style (Integer)
  • fore (Wx::Colour, String, Symbol) 


1445
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1445

def style_set_foreground(style, fore) end

#style_set_hot_spot(style, hotspot) ⇒ void

This method returns an undefined value.

Set a style to be a hotspot or not.

Parameters:

  • style (Integer)
  • hotspot (Boolean) 


1610
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1610

def style_set_hot_spot(style, hotspot) end

#style_set_italic(style, italic) ⇒ void

This method returns an undefined value.

Set a style to be italic or not.

Parameters:

  • style (Integer)
  • italic (Boolean) 


1463
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1463

def style_set_italic(style, italic) end

#style_set_size(style, sizePoints) ⇒ void

This method returns an undefined value.

Set the size of characters of a style.

Parameters:

  • style (Integer)
  • sizePoints (Integer) 


1469
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1469

def style_set_size(style, sizePoints) end

#style_set_size_fractional(style, sizeHundredthPoints) ⇒ void

This method returns an undefined value.

Set the size of characters of a style.

Size is in points multiplied by 100.

Parameters:

  • style (Integer)
  • sizeHundredthPoints (Integer) 


1576
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1576

def style_set_size_fractional(style, sizeHundredthPoints) end

#style_set_spec(styleNum, spec) ⇒ void

This method returns an undefined value.

Extract style settings from a spec-string which is composed of one or more of the following comma separated elements:

bold turns on bold italic turns on italics fore:[name or #RRGGBB] sets the foreground colour back:[name or #RRGGBB] sets the background colour face: sets the font face name to use size: sets the font size in points eol turns on eol filling underline turns on underlining

Parameters:

  • styleNum (Integer)
  • spec (String) 


4103
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4103

def style_set_spec(styleNum, spec) end

#style_set_underline(style, underline) ⇒ void

This method returns an undefined value.

Set a style to be underlined or not.

Parameters:

  • style (Integer)
  • underline (Boolean) 


1491
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1491

def style_set_underline(style, underline) end

#style_set_visible(style, visible) ⇒ void

This method returns an undefined value.

Set a style to be visible or not.

Parameters:

  • style (Integer)
  • visible (Boolean) 


1616
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1616

def style_set_visible(style, visible) end

#style_set_weight(style, weight) ⇒ void

This method returns an undefined value.

Set the weight of characters of a style.

The second argument can be an integer or one of the wxSTC_WEIGHT_* constants.

Parameters:

  • style (Integer)
  • weight (Integer) 


1589
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1589

def style_set_weight(style, weight) end

#swap_main_anchor_caret ⇒ void

This method returns an undefined value.

Swap that caret and anchor of the main selection.



1024
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1024

def swap_main_anchor_caret; end

#tab ⇒ void

This method returns an undefined value.

If selection is empty or all on one line replace the selection with a tab character.

If more than one line selected, indent the lines.



3218
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3218

def tab; end

#tags_of_style(style) ⇒ String

Retrieve a ‘ ’ separated list of style tags like “literal quoted string”.

Result is NUL-terminated.

Parameters:

  • style (Integer)

Returns:

  • (String) 


2429
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2429

def tags_of_style(style) end

#target_from_selection ⇒ void

This method returns an undefined value.

Make the target range start and end be the same as the selection range start and end.



273
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 273

def target_from_selection; end

#target_whole_document ⇒ void

This method returns an undefined value.

Sets the target to the whole document.



277
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 277

def target_whole_document; end

#text_height(line) ⇒ Integer

Retrieve the height of a particular line of text in pixels.

Parameters:

  • line (Integer)

Returns:

  • (Integer) 


628
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 628

def text_height(line) end

#text_width(style, text) ⇒ Integer

Measure the pixel width of some text in a particular style.

Does not handle tab or control characters.

Parameters:

  • style (Integer)
  • text (String)

Returns:

  • (Integer) 


623
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 623

def text_width(style, text) end

#toggle_caret_sticky ⇒ void

This method returns an undefined value.

Switch between sticky and non-sticky: meant to be bound to a key.



1778
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1778

def toggle_caret_sticky; end

#toggle_fold(line) ⇒ void

This method returns an undefined value.

Switch a header line between expanded and contracted.

Parameters:

  • line (Integer) 


3645
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3645

def toggle_fold(line) end

#toggle_fold_show_text(line, text) ⇒ void

This method returns an undefined value.

Switch a header line between expanded and contracted and show some text after the line.

Parameters:

  • line (Integer)
  • text (String) 


3651
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3651

def toggle_fold_show_text(line, text) end

#undo ⇒ void

This method returns an undefined value.

Undo one action in the undo history.



458
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 458

def undo; end

#upper_case ⇒ void

This method returns an undefined value.

Transform the selection to upper case.



3276
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3276

def upper_case; end

#use_pop_up(popUpMode) ⇒ void

This method returns an undefined value.

Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button on certain areas.

The input should be one of the wxSTC_POPUP_* constants. <div class=“wxrb-remark”> Remark: <p>When ContextMenuEvent is used to create a custom popup menu, this function should be called with Wx::STC::STC_POPUP_NEVER. Otherwise the default menu will be shown instead of the custom one. </p> </div>

Parameters:

  • popUpMode (Integer) 


3505
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3505

def use_pop_up(popUpMode) end

#user_list_show(listType, itemList) ⇒ void

This method returns an undefined value.

Display a list of strings and send notification when user chooses one.

Parameters:

  • listType (Integer)
  • itemList (String) 


3050
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3050

def user_list_show(listType, itemList) end

#vc_home ⇒ void

This method returns an undefined value.

Move caret to before first visible character on line.

If already there move to first character on line.



3236
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3236

def vc_home; end

#vc_home_display ⇒ void

This method returns an undefined value.

Move caret to before first visible character on display line.

If already there move to first character on display line.



3468
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3468

def vc_home_display; end

#vc_home_display_extend ⇒ void

This method returns an undefined value.

Like VCHomeDisplay but extending selection to new caret position.



3472
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3472

def vc_home_display_extend; end

#vc_home_extend ⇒ void

This method returns an undefined value.

Like VCHome but extending selection to new caret position.



3240
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3240

def vc_home_extend; end

#vc_home_rect_extend ⇒ void

This method returns an undefined value.

Move caret to before first visible character on line.

If already there move to first character on line. In either case, extend rectangular selection to new caret position.



3400
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3400

def vc_home_rect_extend; end

#vc_home_wrap ⇒ void

This method returns an undefined value.

Like VCHome but when word-wrap is enabled goes first to start of display line VCHomeDisplay, then behaves like VCHome.



3326
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3326

def vc_home_wrap; end

#vc_home_wrap_extend ⇒ void

This method returns an undefined value.

Like VCHomeExtend but when word-wrap is enabled extends first to start of display line VCHomeDisplayExtend, then behaves like VCHomeExtend.



3330
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3330

def vc_home_wrap_extend; end

#vertical_centre_caret ⇒ void

This method returns an undefined value.

Centre current line in window.



3454
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3454

def vertical_centre_caret; end

#visible_from_doc_line(docLine) ⇒ Integer

Find the display line of a document line taking hidden lines into account.

Parameters:

  • docLine (Integer)

Returns:

  • (Integer) 


3573
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3573

def visible_from_doc_line(docLine) end

#word_end_position(pos, onlyWordCharacters) ⇒ Integer

Get position of end of word.

Parameters:

  • pos (Integer)
  • onlyWordCharacters (Boolean)

Returns:

  • (Integer) 


1352
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1352

def word_end_position(pos, onlyWordCharacters) end

#word_left ⇒ void

This method returns an undefined value.

Move caret left one word.



3140
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3140

def word_left; end

#word_left_end ⇒ void

This method returns an undefined value.

Move caret left one word, position cursor at end of word.



3432
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3432

def word_left_end; end

#word_left_end_extend ⇒ void

This method returns an undefined value.

Move caret left one word, position cursor at end of word, extending selection to new caret position.



3436
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3436

def word_left_end_extend; end

#word_left_extend ⇒ void

This method returns an undefined value.

Move caret left one word extending selection to new caret position.



3144
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3144

def word_left_extend; end

#word_part_left ⇒ void

This method returns an undefined value.

Move to the previous change in capitalisation.



3338
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3338

def word_part_left; end

#word_part_left_extend ⇒ void

This method returns an undefined value.

Move to the previous change in capitalisation extending selection to new caret position.



3342
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3342

def word_part_left_extend; end

#word_part_right ⇒ void

This method returns an undefined value.

Move to the change next in capitalisation.



3346
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3346

def word_part_right; end

#word_part_right_extend ⇒ void

This method returns an undefined value.

Move to the next change in capitalisation extending selection to new caret position.



3350
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3350

def word_part_right_extend; end

#word_right ⇒ void

This method returns an undefined value.

Move caret right one word.



3148
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3148

def word_right; end

#word_right_end ⇒ void

This method returns an undefined value.

Move caret right one word, position cursor at end of word.



3440
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3440

def word_right_end; end

#word_right_end_extend ⇒ void

This method returns an undefined value.

Move caret right one word, position cursor at end of word, extending selection to new caret position.



3444
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3444

def word_right_end_extend; end

#word_right_extend ⇒ void

This method returns an undefined value.

Move caret right one word extending selection to new caret position.



3152
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3152

def word_right_extend; end

#word_start_position(pos, onlyWordCharacters) ⇒ Integer

Get position of start of word.

Parameters:

  • pos (Integer)
  • onlyWordCharacters (Boolean)

Returns:

  • (Integer) 


1346
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1346

def word_start_position(pos, onlyWordCharacters) end

#wrap_count(docLine) ⇒ Integer

The number of display lines needed to wrap a document line.

Parameters:

  • docLine (Integer)

Returns:

  • (Integer) 


3736
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3736

def wrap_count(docLine) end

#write_text(text) ⇒ void

This method returns an undefined value.

Writes the text into the text control at the current insertion position.

Remark:

Newlines in the text string are the only control characters allowed, and they will cause appropriate line breaks. See operator<<() and #append_text for more convenient ways of writing to the window. After the write operation, the insertion point will be at the end of the inserted text, so subsequent write operations will be appended. To append text after the user may have interacted with the control, call TextCtrl#set_insertion_point_end before writing.

Parameters:

  • text (String) —

    Text to write to the text control.



4252
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4252

def write_text(text) end

#xy_to_position(x, y) ⇒ Integer

Converts the given zero based column and line number to a position.

The position value, or -1 if x or y was invalid.

Parameters:

  • x (Integer) —

    The column number.

  • y (Integer) —

    The line number.

Returns:

  • (Integer) 


4412
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4412

def xy_to_position(x, y) end

#zoom_in ⇒ void

This method returns an undefined value.

Magnify the displayed text by increasing the sizes by 1 point.



3840
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3840

def zoom_in; end

#zoom_out ⇒ void

This method returns an undefined value.

Make the displayed text smaller by decreasing the sizes by 1 point.



3844
 
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3844

def zoom_out; end