Class: Wx::STC::StyledTextCtrl
- 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
Class Method Summary collapse
-
.get_library_version_info ⇒ Wx::VersionInfo
Returns the version of the Scintilla library used by this control.
Instance Method Summary collapse
-
#add_selection(caret, anchor) ⇒ Integer
Add a selection.
-
#add_tab_stop(line, x) ⇒ void
Add an explicit tab stop for a line.
-
#add_text(text) ⇒ void
Add text to the document at current position.
-
#add_undo_action(token, flags) ⇒ void
Add a container action to the undo stack.
-
#allocate(bytes) ⇒ void
Enlarge the document to a particular size of text bytes.
-
#allocate_extended_styles(numberStyles) ⇒ Integer
Allocate some extended (>255) style numbers and return the start of the range.
-
#allocate_sub_styles(styleBase, numberStyles) ⇒ Integer
Allocate a set of sub styles for a particular base style, returning start of range.
-
#annotation_clear_all ⇒ void
Clear the annotations from all lines.
-
#annotation_clear_line(line) ⇒ void
Clear annotations from the given line.
-
#annotation_get_lines(line) ⇒ Integer
Get the number of annotation lines for a line.
-
#annotation_get_style(line) ⇒ Integer
Get the style number for the annotations for a line.
-
#annotation_get_style_offset ⇒ Integer
Get the start of the range of style numbers used for annotations.
-
#annotation_get_styles(line) ⇒ String
Get the annotation styles for a line.
-
#annotation_get_text(line) ⇒ String
Get the annotation text for a line.
-
#annotation_get_visible ⇒ Integer
Get the visibility for the annotations for a view.
-
#annotation_set_style(line, style) ⇒ void
Set the style number for the annotations for a line.
-
#annotation_set_style_offset(style) ⇒ void
Get the start of the range of style numbers used for annotations.
-
#annotation_set_styles(line, styles) ⇒ void
Set the annotation styles for a line.
-
#annotation_set_text(line, text) ⇒ void
Set the annotation text for a line.
-
#annotation_set_visible(visible) ⇒ void
Set the visibility for the annotations for a view.
-
#append_text(text) ⇒ void
Append a string to the end of the document without changing the selection.
-
#auto_comp_active ⇒ Boolean
Is there an auto-completion list visible?.
-
#auto_comp_cancel ⇒ void
Remove the auto-completion list from the screen.
-
#auto_comp_complete ⇒ void
User has selected an item so remove the list and insert the selection.
-
#auto_comp_get_auto_hide ⇒ Boolean
Retrieve whether or not autocompletion is hidden automatically when nothing matches.
-
#auto_comp_get_cancel_at_start ⇒ Boolean
Retrieve whether auto-completion cancelled by backspacing before start.
-
#auto_comp_get_case_insensitive_behaviour ⇒ Integer
Get auto-completion case insensitive behaviour.
-
#auto_comp_get_choose_single ⇒ Boolean
Retrieve whether a single item auto-completion list automatically choose the item.
-
#auto_comp_get_current ⇒ Integer
Get currently selected item position in the auto-completion list.
-
#auto_comp_get_current_text ⇒ String
Get currently selected item text in the auto-completion list.
-
#auto_comp_get_drop_rest_of_word ⇒ Boolean
Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion.
-
#auto_comp_get_ignore_case ⇒ Boolean
Retrieve state of ignore case flag.
-
#auto_comp_get_max_height ⇒ Integer
Set the maximum height, in rows, of auto-completion and user lists.
-
#auto_comp_get_max_width ⇒ Integer
Get the maximum width, in characters, of auto-completion and user lists.
-
#auto_comp_get_multi ⇒ Integer
Retrieve the effect of autocompleting when there are multiple selections.
-
#auto_comp_get_order ⇒ Integer
Get the way autocompletion lists are ordered.
-
#auto_comp_get_separator ⇒ Integer
Retrieve the auto-completion list separator character.
-
#auto_comp_get_type_separator ⇒ Integer
Retrieve the auto-completion list type-separator character.
-
#auto_comp_pos_start ⇒ Integer
Retrieve the position of the caret when the auto-completion list was displayed.
-
#auto_comp_select(select) ⇒ void
Select the item in the auto-completion list that starts with a string.
-
#auto_comp_set_auto_hide(autoHide) ⇒ void
Set whether or not autocompletion is hidden automatically when nothing matches.
-
#auto_comp_set_cancel_at_start(cancel) ⇒ void
Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created.
-
#auto_comp_set_case_insensitive_behaviour(behaviour) ⇒ void
Set auto-completion case insensitive behaviour to either prefer case-sensitive matches or have no preference.
-
#auto_comp_set_choose_single(chooseSingle) ⇒ void
Should a single item auto-completion list automatically choose the item.
-
#auto_comp_set_drop_rest_of_word(dropRestOfWord) ⇒ void
Set whether or not autocompletion deletes any word characters after the inserted text upon completion.
-
#auto_comp_set_fill_ups(characterSet) ⇒ void
Define a set of characters that when typed will cause the autocompletion to choose the selected item.
-
#auto_comp_set_ignore_case(ignoreCase) ⇒ void
Set whether case is significant when performing auto-completion searches.
-
#auto_comp_set_max_height(rowCount) ⇒ void
Set the maximum height, in rows, of auto-completion and user lists.
-
#auto_comp_set_max_width(characterCount) ⇒ void
Set the maximum width, in characters, of auto-completion and user lists.
-
#auto_comp_set_multi(multi) ⇒ void
Change the effect of autocompleting when there are multiple selections.
-
#auto_comp_set_order(order) ⇒ void
Set the way autocompletion lists are ordered.
-
#auto_comp_set_separator(separatorCharacter) ⇒ void
Change the separator character in the string setting up an auto-completion list.
-
#auto_comp_set_type_separator(separatorCharacter) ⇒ void
Change the type-separator character in the string setting up an auto-completion list.
-
#auto_comp_show(lengthEntered, itemList) ⇒ void
Display an auto-completion list.
-
#auto_comp_stops(characterSet) ⇒ void
Define a set of character that when typed cancel the auto-completion list.
-
#back_tab ⇒ void
Dedent the selected lines.
-
#begin_undo_action ⇒ void
Start a sequence of actions that is undone and redone as a unit.
-
#brace_bad_light(pos) ⇒ void
Highlight the character at a position indicating there is no matching brace.
-
#brace_bad_light_indicator(useSetting, indicator) ⇒ void
Use specified indicator to highlight non matching brace instead of changing its style.
-
#brace_highlight(posA, posB) ⇒ void
Highlight the characters at two positions.
-
#brace_highlight_indicator(useSetting, indicator) ⇒ void
Use specified indicator to highlight matching braces instead of changing their style.
-
#brace_match(pos, maxReStyle = 0) ⇒ Integer
Find the position of a matching brace or STC_INVALID_POSITION if no match.
-
#call_tip_active ⇒ Boolean
Is there an active call tip?.
-
#call_tip_cancel ⇒ void
Remove the call tip from the screen.
-
#call_tip_pos_at_start ⇒ Integer
Retrieve the position where the caret was before displaying the call tip.
-
#call_tip_set_background(back) ⇒ void
Set the background colour for the call tip.
-
#call_tip_set_foreground(fore) ⇒ void
Set the foreground colour for the call tip.
-
#call_tip_set_foreground_highlight(fore) ⇒ void
Set the foreground colour for the highlighted part of the call tip.
-
#call_tip_set_highlight(highlightStart, highlightEnd) ⇒ void
Highlight a segment of the definition.
-
#call_tip_set_pos_at_start(posStart) ⇒ void
Set the start position in order to change when backspacing removes the calltip.
-
#call_tip_set_position(above) ⇒ void
Set position of calltip, above or below text.
-
#call_tip_show(pos, definition) ⇒ void
Show a call tip containing a definition near position pos.
-
#call_tip_use_style(tabSize) ⇒ void
Enable use of STC_STYLE_CALLTIP and set call tip tab size in pixels.
-
#can_paste ⇒ Boolean
(also: #can_paste?)
Will a paste succeed?.
-
#can_redo ⇒ Boolean
(also: #can_redo?)
Are there any redoable actions in the undo history?.
-
#can_undo ⇒ Boolean
(also: #can_undo?)
Are there any undoable actions in the undo history?.
-
#cancel ⇒ void
Cancel any modes such as call tip or auto-completion list display.
-
#change_insertion(length, text) ⇒ void
Change the text that is being inserted in response to STC_MOD_INSERTCHECK.
-
#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.
-
#char_left ⇒ void
Move caret left one character.
-
#char_left_extend ⇒ void
Move caret left one character extending selection to new caret position.
-
#char_left_rect_extend ⇒ void
Move caret left one character, extending rectangular selection to new caret position.
-
#char_position_from_point(x, y) ⇒ Integer
Find the position of a character from a point within the window.
-
#char_position_from_point_close(x, y) ⇒ Integer
Find the position of a character from a point within the window.
-
#char_right ⇒ void
Move caret right one character.
-
#char_right_extend ⇒ void
Move caret right one character extending selection to new caret position.
-
#char_right_rect_extend ⇒ void
Move caret right one character, extending rectangular selection to new caret position.
-
#choose_caret_x ⇒ void
Set the last x chosen value to be the caret x position.
-
#clear ⇒ void
Clear the selection.
-
#clear_all ⇒ void
Delete all text in the document.
-
#clear_document_style ⇒ void
Set all style bytes to 0, remove all folding information.
-
#clear_registered_images ⇒ void
Clear all the registered images.
-
#clear_representation(encodedCharacter) ⇒ void
Remove a character representation.
-
#clear_selections ⇒ void
Clear selections to a single empty stream selection.
-
#clear_tab_stops(line) ⇒ void
Clear explicit tabstops on a line.
-
#cmd_key_assign(key, modifiers, cmd) ⇒ void
When key+modifier combination keyDefinition is pressed perform sciCommand.
-
#cmd_key_clear(key, modifiers) ⇒ void
When key+modifier combination keyDefinition is pressed do nothing.
-
#cmd_key_clear_all ⇒ void
Drop all key mappings.
-
#cmd_key_execute(cmd) ⇒ void
Perform one of the operations defined by the Wx::STC_CMD_* constants.
-
#colourise(start, end_) ⇒ void
Colourise a segment of the document using the current lexing language.
-
#contracted_fold_next(lineStart) ⇒ Integer
Find the next line at or after lineStart that is a contracted fold header line.
-
#convert_eo_ls(eolMode) ⇒ void
Convert all line endings in the document to one mode.
-
#copy ⇒ void
Copy the selection to the clipboard.
-
#copy_allow_line ⇒ void
Copy the selection, if selection empty copy the line with the caret.
-
#copy_range(start, end_) ⇒ void
Copy a range of text to the clipboard.
-
#copy_text(length, text) ⇒ void
Copy argument text to the clipboard.
-
#count_characters(start, end_) ⇒ Integer
Count characters between two positions.
-
#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.
-
#cut ⇒ void
Cut the selection to the clipboard.
-
#del_line_left ⇒ void
Delete back from the current position to the start of the line.
-
#del_line_right ⇒ void
Delete forwards from the current position to the end of the line.
-
#del_word_left ⇒ void
Delete the word to the left of the caret.
-
#del_word_right ⇒ void
Delete the word to the right of the caret.
-
#del_word_right_end ⇒ void
Delete the word to the right of the caret, but not the trailing non-word characters.
-
#delete_back ⇒ void
Delete the selection or if no selection, the character before the caret.
-
#delete_back_not_line ⇒ void
Delete the selection or if no selection, the character before the caret.
-
#delete_range(start, lengthDelete) ⇒ void
Delete a range of text in the document.
-
#describe_key_word_sets ⇒ String
Retrieve a ‘n’ separated list of descriptions of the keyword sets understood by the current lexer.
-
#describe_property(name) ⇒ String
Describe a property.
-
#discard_edits ⇒ void
Resets the internal modified flag as if the current changes had been saved.
-
#distance_to_secondary_styles ⇒ Integer
Where styles are duplicated by a feature such as active/inactive code return the distance between the two types.
-
#do_drag_enter(x, y, defaultRes) ⇒ Wx::DragResult
Allow for simulating a DnD DragEnter.
-
#do_drag_leave ⇒ void
Allow for simulating a DnD DragLeave.
-
#do_drag_over(x, y, defaultRes) ⇒ Wx::DragResult
Allow for simulating a DnD DragOver.
-
#do_drop_text(x, y, data) ⇒ Boolean
Allow for simulating a DnD DropText.
-
#doc_line_from_visible(displayLine) ⇒ Integer
Find the document line of a display line taking hidden lines into account.
-
#document_end ⇒ void
Move caret to last position in document.
-
#document_end_extend ⇒ void
Move caret to last position in document extending selection to new caret position.
-
#document_start ⇒ void
Move caret to first position in document.
-
#document_start_extend ⇒ void
Move caret to first position in document extending selection to new caret position.
-
#drop_selection_n(selection) ⇒ void
Drop one selection.
-
#each_line {|line| ... } ⇒ Object, Enumerator
Yield each line to the given block.
-
#edit_toggle_overtype ⇒ void
Switch from insert to overtype mode or the reverse.
-
#empty_undo_buffer ⇒ void
Delete the undo history.
-
#end_undo_action ⇒ void
End a sequence of actions that is undone and redone as a unit.
-
#ensure_caret_visible ⇒ void
Ensure the caret is visible.
-
#ensure_visible(line) ⇒ void
Ensure a particular line is visible by expanding any header line hiding it.
-
#ensure_visible_enforce_policy(line) ⇒ void
Ensure a particular line is visible by expanding any header line hiding it.
-
#expand_children(line, level) ⇒ void
Expand a fold header and all children.
-
#find_column(line, column) ⇒ Integer
Find the position of a column on a line taking into account tabs and multi-byte characters.
-
#find_text(minPos, maxPos, text, flags = 0) ⇒ Array(Integer,Integer)
Find some text in the document.
-
#fold_all(action) ⇒ void
Expand or contract all fold headers.
-
#fold_children(line, action) ⇒ void
Expand or contract a fold header and its children.
-
#fold_display_text_set_style(style) ⇒ void
Set the style of fold display text.
-
#fold_line(line, action) ⇒ void
Expand or contract a fold header.
-
#form_feed ⇒ void
Insert a Form Feed character.
-
#format_range(doDraw, startPos, endPos, draw, target, renderRect, pageRect) ⇒ Integer
On Windows, will draw the document into a display context such as a printer.
-
#free_sub_styles ⇒ void
Free allocated sub styles.
-
#get_additional_caret_foreground ⇒ Wx::Colour
(also: #additional_caret_foreground)
Get the foreground colour of additional carets.
-
#get_additional_carets_blink ⇒ Boolean
(also: #additional_carets_blink)
Whether additional carets will blink.
-
#get_additional_carets_visible ⇒ Boolean
(also: #additional_carets_visible)
Whether additional carets are visible.
-
#get_additional_sel_alpha ⇒ Integer
(also: #additional_sel_alpha)
Get the alpha of the selection.
-
#get_additional_selection_typing ⇒ Boolean
(also: #additional_selection_typing)
Whether typing can be performed into multiple selections.
-
#get_all_lines_visible ⇒ Boolean
(also: #all_lines_visible)
Are all lines visible?.
-
#get_anchor ⇒ Integer
(also: #anchor)
Returns the position of the opposite end of the selection to the caret.
-
#get_automatic_fold ⇒ Integer
(also: #automatic_fold)
Get automatic folding behaviours.
-
#get_back_space_un_indents ⇒ Boolean
(also: #back_space_un_indents)
Does a backspace pressed when caret is within indentation unindent?.
-
#get_buffered_draw ⇒ Boolean
(also: #buffered_draw)
Is drawing done first into a buffer or direct to the screen?.
-
#get_caret_foreground ⇒ Wx::Colour
(also: #caret_foreground)
Get the foreground colour of the caret.
-
#get_caret_line_back_alpha ⇒ Integer
(also: #caret_line_back_alpha)
Get the background alpha of the caret line.
-
#get_caret_line_background ⇒ Wx::Colour
(also: #caret_line_background)
Get the colour of the background of the line containing the caret.
-
#get_caret_line_visible ⇒ Boolean
(also: #caret_line_visible)
Is the background of the line containing the caret in a different colour?.
-
#get_caret_line_visible_always ⇒ Boolean
(also: #caret_line_visible_always)
Is the caret line always visible?.
-
#get_caret_period ⇒ Integer
(also: #caret_period)
Get the time in milliseconds that the caret is on and off.
-
#get_caret_sticky ⇒ Integer
(also: #caret_sticky)
Can the caret preferred x position only be changed by explicit movement commands?.
-
#get_caret_style ⇒ Integer
(also: #caret_style)
Returns the current style of the caret.
-
#get_caret_width ⇒ Integer
(also: #caret_width)
Returns the width of the insert mode caret.
-
#get_char_at(pos) ⇒ Integer
(also: #char_at)
Returns the character byte at the position.
-
#get_code_page ⇒ Integer
(also: #code_page)
Get the code page used to interpret the bytes of the document as characters.
-
#get_column(pos) ⇒ Integer
(also: #column)
Retrieve the column number of a position, taking tab width into account.
-
#get_control_char_symbol ⇒ Integer
(also: #control_char_symbol)
Get the way control characters are displayed.
-
#get_cur_line ⇒ Array(String,Integer)
(also: #cur_line)
Retrieve the text of the line containing the caret.
-
#get_current_line ⇒ Integer
(also: #current_line)
Returns the line number of the line with the caret.
-
#get_current_pos ⇒ Integer
(also: #current_pos)
Returns the position of the caret.
-
#get_edge_colour ⇒ Wx::Colour
(also: #edge_colour)
Retrieve the colour used in edge indication.
-
#get_edge_column ⇒ Integer
(also: #edge_column)
Retrieve the column number which text should be kept within.
-
#get_edge_mode ⇒ Integer
(also: #edge_mode)
Retrieve the edge highlight mode.
-
#get_end_at_last_line ⇒ Boolean
(also: #end_at_last_line)
Retrieve whether the maximum scroll position has the last line at the bottom of the view.
-
#get_end_styled ⇒ Integer
(also: #end_styled)
Retrieve the position of the last correctly styled character.
-
#get_eol_mode ⇒ Integer
(also: #eol_mode)
Retrieve the current end of line mode - one of STC_EOL_CRLF, STC_EOL_CR, or STC_EOL_LF.
-
#get_extra_ascent ⇒ Integer
(also: #extra_ascent)
Get extra ascent for each line.
-
#get_extra_descent ⇒ Integer
(also: #extra_descent)
Get extra descent for each line.
-
#get_first_visible_line ⇒ Integer
(also: #first_visible_line)
Retrieve the display line at the top of the display.
-
#get_fold_expanded(line) ⇒ Boolean
(also: #fold_expanded)
Is a header line expanded?.
-
#get_fold_level(line) ⇒ Integer
(also: #fold_level)
Retrieve the fold level of a line.
-
#get_fold_parent(line) ⇒ Integer
(also: #fold_parent)
Find the parent line of a child line.
-
#get_font_quality ⇒ Integer
(also: #font_quality)
Retrieve the quality level for text.
-
#get_gap_position ⇒ Integer
(also: #gap_position)
Return a position which, to avoid performance costs, should not be within the range of a call to GetRangePointer.
-
#get_highlight_guide ⇒ Integer
(also: #highlight_guide)
Get the highlighted indentation guide column.
-
#get_hotspot_active_background ⇒ Wx::Colour
(also: #hotspot_active_background)
Get the back colour for active hotspots.
-
#get_hotspot_active_foreground ⇒ Wx::Colour
(also: #hotspot_active_foreground)
Get the fore colour for active hotspots.
-
#get_hotspot_active_underline ⇒ Boolean
(also: #hotspot_active_underline)
Get whether underlining for active hotspots.
-
#get_hotspot_single_line ⇒ Boolean
(also: #hotspot_single_line)
Get the HotspotSingleLine property.
-
#get_identifier ⇒ Integer
(also: #identifier)
Get the identifier.
-
#get_idle_styling ⇒ Integer
(also: #idle_styling)
Retrieve the limits to idle styling.
-
#get_ime_interaction ⇒ Integer
(also: #ime_interaction)
Is the IME displayed in a window or inline?.
-
#get_indent ⇒ Integer
(also: #indent)
Retrieve indentation size.
-
#get_indentation_guides ⇒ Integer
(also: #indentation_guides)
Are the indentation guides visible?.
-
#get_indicator_current ⇒ Integer
(also: #indicator_current)
Get the current indicator.
-
#get_indicator_value ⇒ Integer
(also: #indicator_value)
Get the current indicator value.
-
#get_insertion_point ⇒ Integer
(also: #insertion_point)
Returns the insertion point, or cursor, position.
-
#get_last_child(line, level) ⇒ Integer
(also: #last_child)
Find the last child line of a header line.
-
#get_last_keydown_processed ⇒ Boolean
(also: #last_keydown_processed)
Can be used to prevent the EVT_CHAR handler from adding the char.
-
#get_last_position ⇒ Integer
(also: #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.
-
#get_layout_cache ⇒ Integer
(also: #layout_cache)
Retrieve the degree of caching of layout information.
-
#get_length ⇒ Integer
(also: #length)
Returns the number of bytes in the document.
-
#get_lexer ⇒ Integer
(also: #lexer)
Retrieve the lexing language of the document.
-
#get_lexer_language ⇒ String
(also: #lexer_language)
Retrieve the lexing language of the document.
-
#get_line(line) ⇒ String
(also: #line)
Retrieve the contents of a line.
-
#get_line_count ⇒ Integer
(also: #line_count)
Returns the number of lines in the document.
-
#get_line_end_position(line) ⇒ Integer
(also: #line_end_position)
Get the position after the last visible characters on a line.
-
#get_line_end_types_active ⇒ Integer
(also: #line_end_types_active)
Get the line end types currently recognised.
-
#get_line_end_types_allowed ⇒ Integer
(also: #line_end_types_allowed)
Get the line end types currently allowed.
-
#get_line_end_types_supported ⇒ Integer
(also: #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.
-
#get_line_indent_position(line) ⇒ Integer
(also: #line_indent_position)
Retrieve the position before the first non indentation character on a line.
-
#get_line_indentation(line) ⇒ Integer
(also: #line_indentation)
Retrieve the number of columns that a line is indented.
-
#get_line_length(lineNo) ⇒ Integer
Gets the length of the specified line, not including any trailing newline character(s).
-
#get_line_sel_end_position(line) ⇒ Integer
(also: #line_sel_end_position)
Retrieve the position of the end of the selection at the given line (STC_INVALID_POSITION if no selection on this line).
-
#get_line_sel_start_position(line) ⇒ Integer
(also: #line_sel_start_position)
Retrieve the position of the start of the selection at the given line (STC_INVALID_POSITION if no selection on this line).
-
#get_line_state(line) ⇒ Integer
(also: #line_state)
Retrieve the extra styling information for a line.
-
#get_line_text(lineNo) ⇒ String
(also: #line_text)
Returns the contents of a given line in the text control, not including any trailing newline character(s).
-
#get_line_visible(line) ⇒ Boolean
(also: #line_visible)
Is a line visible?.
-
#get_main_selection ⇒ Integer
(also: #main_selection)
Which selection is the main selection.
-
#get_margin_background(margin) ⇒ Wx::Colour
(also: #margin_background)
Retrieve the background colour of a margin.
-
#get_margin_count ⇒ Integer
(also: #margin_count)
How many margins are there?.
-
#get_margin_cursor(margin) ⇒ Integer
(also: #margin_cursor)
Retrieve the cursor shown in a margin.
-
#get_margin_left ⇒ Integer
(also: #margin_left)
Returns the size in pixels of the left margin.
-
#get_margin_mask(margin) ⇒ Integer
(also: #margin_mask)
Retrieve the marker mask of a margin.
-
#get_margin_options ⇒ Integer
(also: #margin_options)
Get the margin options.
-
#get_margin_right ⇒ Integer
(also: #margin_right)
Returns the size in pixels of the right margin.
-
#get_margin_sensitive(margin) ⇒ Boolean
(also: #margin_sensitive)
Retrieve the mouse click sensitivity of a margin.
-
#get_margin_type(margin) ⇒ Integer
(also: #margin_type)
Retrieve the type of a margin.
-
#get_margin_width(margin) ⇒ Integer
(also: #margin_width)
Retrieve the width of a margin in pixels.
-
#get_marker_symbol_defined(markerNumber) ⇒ Integer
(also: #marker_symbol_defined)
Which symbol was defined for markerNumber with MarkerDefine.
-
#get_max_line_state ⇒ Integer
(also: #max_line_state)
Retrieve the last line number that has line state.
-
#get_mod_event_mask ⇒ Integer
(also: #mod_event_mask)
Get which document modification events are sent to the container.
-
#get_modify ⇒ Boolean
(also: #modify)
Is the document different from when it was last saved?.
-
#get_mouse_down_captures ⇒ Boolean
(also: #mouse_down_captures)
Get whether mouse gets captured.
-
#get_mouse_dwell_time ⇒ Integer
(also: #mouse_dwell_time)
Retrieve the time the mouse must sit still to generate a mouse dwell event.
-
#get_mouse_selection_rectangular_switch ⇒ Boolean
(also: #mouse_selection_rectangular_switch)
Whether switching to rectangular mode while selecting with the mouse is allowed.
-
#get_mouse_wheel_captures ⇒ Boolean
(also: #mouse_wheel_captures)
Get whether mouse wheel can be active outside the window.
-
#get_multi_paste ⇒ Integer
(also: #multi_paste)
Retrieve the effect of pasting when there are multiple selections.
-
#get_multiple_selection ⇒ Boolean
(also: #multiple_selection)
Whether multiple selections can be made.
-
#get_next_tab_stop(line, x) ⇒ Integer
(also: #next_tab_stop)
Find the next explicit tab stop position on a line after a position.
-
#get_number_of_lines ⇒ Integer
(also: #number_of_lines)
Returns the number of lines in the text control buffer.
-
#get_overtype ⇒ Boolean
(also: #overtype)
Returns true if overtype mode is active otherwise false is returned.
-
#get_paste_convert_endings ⇒ Boolean
(also: #paste_convert_endings)
Get convert-on-paste setting.
-
#get_phases_draw ⇒ Integer
(also: #phases_draw)
How many phases is drawing done in?.
-
#get_position_cache_size ⇒ Integer
(also: #position_cache_size)
How many entries are allocated to the position cache?.
-
#get_primary_style_from_style(style) ⇒ Integer
(also: #primary_style_from_style)
For a secondary style, return the primary style, else return the argument.
-
#get_print_colour_mode ⇒ Integer
(also: #print_colour_mode)
Returns the print colour mode.
-
#get_print_magnification ⇒ Integer
(also: #print_magnification)
Returns the print magnification.
-
#get_print_wrap_mode ⇒ Integer
(also: #print_wrap_mode)
Is printing line wrapped?.
-
#get_property(key) ⇒ String
(also: #property)
Retrieve a “property” value previously set with SetProperty.
-
#get_property_expanded(key) ⇒ String
(also: #property_expanded)
Retrieve a “property” value previously set with SetProperty, with “$()” variable replacement on returned buffer.
-
#get_property_int(key, defaultValue = 0) ⇒ Integer
(also: #property_int)
Retrieve a “property” value previously set with SetProperty, interpreted as an int AFTER any “$()” variable replacement.
-
#get_punctuation_chars ⇒ String
(also: #punctuation_chars)
Get the set of characters making up punctuation characters.
-
#get_read_only ⇒ Boolean
(also: #read_only)
In read-only mode?.
-
#get_rectangular_selection_anchor ⇒ Integer
(also: #rectangular_selection_anchor)
Return the anchor position of the rectangular selection.
-
#get_rectangular_selection_anchor_virtual_space ⇒ Integer
(also: #rectangular_selection_anchor_virtual_space)
Return the virtual space of the anchor of the rectangular selection.
-
#get_rectangular_selection_caret ⇒ Integer
(also: #rectangular_selection_caret)
Return the caret position of the rectangular selection.
-
#get_rectangular_selection_caret_virtual_space ⇒ Integer
(also: #rectangular_selection_caret_virtual_space)
Return the virtual space of the caret of the rectangular selection.
-
#get_rectangular_selection_modifier ⇒ Integer
(also: #rectangular_selection_modifier)
Get the modifier key used for rectangular selection.
-
#get_representation(encodedCharacter) ⇒ String
(also: #representation)
Set the way a character is drawn.
-
#get_scroll_width ⇒ Integer
(also: #scroll_width)
Retrieve the document width assumed for scrolling.
-
#get_scroll_width_tracking ⇒ Boolean
(also: #scroll_width_tracking)
Retrieve whether the scroll width tracks wide lines.
-
#get_search_flags ⇒ Integer
(also: #search_flags)
Get the search flags used by SearchInTarget.
-
#get_sel_alpha ⇒ Integer
(also: #sel_alpha)
Get the alpha of the selection.
-
#get_sel_eol_filled ⇒ Boolean
(also: #sel_eol_filled)
Is the selection end of line filled?.
-
#get_selected_text ⇒ String
(also: #selected_text)
Retrieve the selected text.
-
#get_selection ⇒ Array(Integer, Integer)
(also: #selection)
Gets the current selection span.
-
#get_selection_empty ⇒ Boolean
(also: #selection_empty)
Is every selected range empty?.
-
#get_selection_end ⇒ Integer
(also: #selection_end)
Returns the position at the end of the selection.
-
#get_selection_mode ⇒ Integer
(also: #selection_mode)
Get the mode of the current selection.
-
#get_selection_n_anchor(selection) ⇒ Integer
(also: #selection_n_anchor)
Return the anchor position of the nth selection.
-
#get_selection_n_anchor_virtual_space(selection) ⇒ Integer
(also: #selection_n_anchor_virtual_space)
Return the virtual space of the anchor of the nth selection.
-
#get_selection_n_caret(selection) ⇒ Integer
(also: #selection_n_caret)
Return the caret position of the nth selection.
-
#get_selection_n_caret_virtual_space(selection) ⇒ Integer
(also: #selection_n_caret_virtual_space)
Return the virtual space of the caret of the nth selection.
-
#get_selection_n_end(selection) ⇒ Integer
(also: #selection_n_end)
Returns the position at the end of the selection.
-
#get_selection_n_start(selection) ⇒ Integer
(also: #selection_n_start)
Returns the position at the start of the selection.
-
#get_selection_start ⇒ Integer
(also: #selection_start)
Returns the position at the start of the selection.
-
#get_selections ⇒ Integer
(also: #selections)
How many selections are there?.
-
#get_status ⇒ Integer
(also: #status)
Get error status.
-
#get_stc_cursor ⇒ Integer
(also: #stc_cursor)
Get cursor type.
-
#get_stc_focus ⇒ Boolean
(also: #stc_focus)
Get internal focus flag.
-
#get_style(position, style) ⇒ Boolean
(also: #style)
This method is inherited from TextAreaBase but is not implemented in StyledTextCtrl.
-
#get_style_at(pos) ⇒ Integer
(also: #style_at)
Returns the style byte at the position.
-
#get_style_from_sub_style(subStyle) ⇒ Integer
(also: #style_from_sub_style)
For a sub style, return the base style, else return the argument.
-
#get_sub_style_bases ⇒ String
(also: #sub_style_bases)
Get the set of base styles that can be extended with sub styles.
-
#get_sub_styles_length(styleBase) ⇒ Integer
(also: #sub_styles_length)
The number of sub styles associated with a base style.
-
#get_sub_styles_start(styleBase) ⇒ Integer
(also: #sub_styles_start)
The starting style number for the sub styles associated with a base style.
-
#get_tab_draw_mode ⇒ Integer
(also: #tab_draw_mode)
Retrieve the current tab draw mode.
-
#get_tab_indents ⇒ Boolean
(also: #tab_indents)
Does a tab pressed when caret is within indentation indent?.
-
#get_tab_width ⇒ Integer
(also: #tab_width)
Retrieve the visible size of a tab.
-
#get_tag(tagNumber) ⇒ String
(also: #tag)
Retrieve the value of a tag from a regular expression search.
-
#get_target_end ⇒ Integer
(also: #target_end)
Get the position that ends the target.
-
#get_target_start ⇒ Integer
(also: #target_start)
Get the position that starts the target.
-
#get_target_text ⇒ String
(also: #target_text)
Retrieve the text in the target.
-
#get_technology ⇒ Integer
(also: #technology)
Get the tech.
-
#get_text ⇒ String
(also: #text)
Retrieve all the text in the document.
-
#get_text_length ⇒ Integer
(also: #text_length)
Retrieve the number of characters in the document.
-
#get_text_range(startPos, endPos) ⇒ String
(also: #text_range)
Retrieve a range of text.
-
#get_two_phase_draw ⇒ Boolean
(also: #two_phase_draw)
Is drawing done in two phases with backgrounds drawn before foregrounds?.
-
#get_undo_collection ⇒ Boolean
(also: #undo_collection)
Is undo history being collected?.
-
#get_use_anti_aliasing ⇒ Boolean
(also: #use_anti_aliasing)
Returns the current UseAntiAliasing setting.
-
#get_use_horizontal_scroll_bar ⇒ Boolean
(also: #use_horizontal_scroll_bar)
Is the horizontal scroll bar visible?.
-
#get_use_tabs ⇒ Boolean
(also: #use_tabs)
Retrieve whether tabs will be used in indentation.
-
#get_use_vertical_scroll_bar ⇒ Boolean
(also: #use_vertical_scroll_bar)
Is the vertical scroll bar visible?.
-
#get_view_eol ⇒ Boolean
(also: #view_eol)
Are the end of line characters visible?.
-
#get_view_white_space ⇒ Integer
(also: #view_white_space)
Are white space characters currently visible? Returns one of Wx::STC_WS_* constants.
-
#get_virtual_space_options ⇒ Integer
(also: #virtual_space_options)
Return options for virtual space behaviour.
-
#get_whitespace_chars ⇒ String
(also: #whitespace_chars)
Get the set of characters making up whitespace for when moving or selecting by word.
-
#get_whitespace_size ⇒ Integer
(also: #whitespace_size)
Get the size of the dots used to mark space characters.
-
#get_word_chars ⇒ String
(also: #word_chars)
Get the set of characters making up words for when moving or selecting by word.
-
#get_wrap_indent_mode ⇒ Integer
(also: #wrap_indent_mode)
Retrieve how wrapped sublines are placed.
-
#get_wrap_mode ⇒ Integer
(also: #wrap_mode)
Retrieve whether text is word wrapped.
-
#get_wrap_start_indent ⇒ Integer
(also: #wrap_start_indent)
Retrieve the start indent for wrapped lines.
-
#get_wrap_visual_flags ⇒ Integer
(also: #wrap_visual_flags)
Retrieve the display mode of visual flags for wrapped lines.
-
#get_wrap_visual_flags_location ⇒ Integer
(also: #wrap_visual_flags_location)
Retrieve the location of visual flags for wrapped lines.
-
#get_x_offset ⇒ Integer
(also: #x_offset)
Get the xOffset (ie, horizontal scroll position).
-
#get_zoom ⇒ Integer
(also: #zoom)
Retrieve the zoom level.
-
#goto_line(line) ⇒ void
Set caret to start of a line and ensure it is visible.
-
#goto_pos(caret) ⇒ void
Set caret to a position and ensure it is visible.
-
#hide_lines(lineStart, lineEnd) ⇒ void
Make a range of lines invisible.
-
#hide_selection(hide) ⇒ void
Draw the selection in normal style or with selection highlighted.
-
#hit_test(pt) ⇒ Array(Wx::TextCtrlHitTestResult,Array(Integer, Integer))
Finds the row and column of the character at the specified point.
-
#home ⇒ void
Move caret to first position on line.
-
#home_display ⇒ void
Move caret to first position on display line.
-
#home_display_extend ⇒ void
Move caret to first position on display line extending selection to new caret position.
-
#home_extend ⇒ void
Move caret to first position on line extending selection to new caret position.
-
#home_rect_extend ⇒ void
Move caret to first position on line, extending rectangular selection to new caret position.
-
#home_wrap ⇒ void
Like Home but when word-wrap is enabled goes first to start of display line HomeDisplay, then to start of document line Home.
-
#home_wrap_extend ⇒ void
Like HomeExtend but when word-wrap is enabled extends first to start of display line HomeDisplayExtend, then to start of document line HomeExtend.
-
#indicator_all_on_for(pos) ⇒ Integer
Are any indicators present at pos?.
-
#indicator_clear_range(start, lengthClear) ⇒ void
Turn an indicator off over a range.
-
#indicator_end(indicator, pos) ⇒ Integer
Where does a particular indicator end?.
-
#indicator_fill_range(start, lengthFill) ⇒ void
Turn an indicator on over a range.
-
#indicator_get_alpha(indicator) ⇒ Integer
Get the alpha fill colour of the given indicator.
-
#indicator_get_flags(indicator) ⇒ Integer
Retrieve the attributes of an indicator.
-
#indicator_get_foreground(indicator) ⇒ Wx::Colour
Retrieve the foreground colour of an indicator.
-
#indicator_get_hover_foreground(indicator) ⇒ Wx::Colour
Retrieve the foreground hover colour of an indicator.
-
#indicator_get_hover_style(indicator) ⇒ Integer
Retrieve the hover style of an indicator.
-
#indicator_get_outline_alpha(indicator) ⇒ Integer
Get the alpha outline colour of the given indicator.
-
#indicator_get_style(indicator) ⇒ Integer
Retrieve the style of an indicator.
-
#indicator_get_under(indicator) ⇒ Boolean
Retrieve whether indicator drawn under or over text.
-
#indicator_set_alpha(indicator, alpha) ⇒ void
Set the alpha fill colour of the given indicator.
-
#indicator_set_flags(indicator, flags) ⇒ void
Set the attributes of an indicator.
-
#indicator_set_foreground(indicator, fore) ⇒ void
Set the foreground colour of an indicator.
-
#indicator_set_hover_foreground(indicator, fore) ⇒ void
Set the foreground hover colour of an indicator.
-
#indicator_set_hover_style(indicator, indicatorStyle) ⇒ void
Set a hover indicator to plain, squiggle or TT.
-
#indicator_set_outline_alpha(indicator, alpha) ⇒ void
Set the alpha outline colour of the given indicator.
-
#indicator_set_style(indicator, indicatorStyle) ⇒ void
Set an indicator to plain, squiggle or TT.
-
#indicator_set_under(indicator, under) ⇒ void
Set an indicator to draw under text or over(default).
-
#indicator_start(indicator, pos) ⇒ Integer
Where does a particular indicator start?.
-
#indicator_value_at(indicator, pos) ⇒ Integer
What value does a particular indicator have at a position?.
-
#initialize(*args) ⇒ StyledTextCtrl
constructor
A new instance of StyledTextCtrl.
-
#insert_text(pos, text) ⇒ void
Insert string at a position.
-
#is_editable ⇒ Boolean
(also: #editable?)
Returns true if the controls contents may be edited by user (note that it always can be changed by the program).
-
#is_modified ⇒ Boolean
(also: #modified?)
Returns true if the text has been modified by user.
-
#is_range_word(start, end_) ⇒ Boolean
(also: #range_word?)
Is the range start..end considered a word?.
-
#line_copy ⇒ void
Copy the line containing the caret.
-
#line_cut ⇒ void
Cut the line containing the caret.
-
#line_delete ⇒ void
Delete the line containing the caret.
-
#line_down ⇒ void
Move caret down one line.
-
#line_down_extend ⇒ void
Move caret down one line extending selection to new caret position.
-
#line_down_rect_extend ⇒ void
Move caret down one line, extending rectangular selection to new caret position.
-
#line_duplicate ⇒ void
Duplicate the current line.
-
#line_end ⇒ void
Move caret to last position on line.
-
#line_end_display ⇒ void
Move caret to last position on display line.
-
#line_end_display_extend ⇒ void
Move caret to last position on display line extending selection to new caret position.
-
#line_end_extend ⇒ void
Move caret to last position on line extending selection to new caret position.
-
#line_end_rect_extend ⇒ void
Move caret to last position on line, extending rectangular selection to new caret position.
-
#line_end_wrap ⇒ void
Like LineEnd but when word-wrap is enabled goes first to end of display line LineEndDisplay, then to start of document line LineEnd.
-
#line_end_wrap_extend ⇒ void
Like LineEndExtend but when word-wrap is enabled extends first to end of display line LineEndDisplayExtend, then to start of document line LineEndExtend.
-
#line_from_position(pos) ⇒ Integer
Retrieve the line containing a position.
-
#line_length(line) ⇒ Integer
How many characters are on a line, including end of line characters?.
-
#line_scroll(columns, lines) ⇒ void
Scroll horizontally and vertically.
-
#line_scroll_down ⇒ void
Scroll the document down, keeping the caret visible.
-
#line_scroll_up ⇒ void
Scroll the document up, keeping the caret visible.
-
#line_transpose ⇒ void
Switch the current line with the previous.
-
#line_up ⇒ void
Move caret up one line.
-
#line_up_extend ⇒ void
Move caret up one line extending selection to new caret position.
-
#line_up_rect_extend ⇒ void
Move caret up one line, extending rectangular selection to new caret position.
-
#lines_join ⇒ void
Join the lines in the target.
-
#lines_on_screen ⇒ Integer
Retrieves the number of lines completely visible.
-
#lines_split(pixelWidth) ⇒ void
Split the lines in the target into lines that are less wide than pixelWidth where possible.
-
#load_file(filename) ⇒ Boolean
Load the contents of filename into the editor.
-
#load_lexer_library(path) ⇒ void
Load a lexer library (dll / so).
-
#lower_case ⇒ void
Transform the selection to lower case.
-
#margin_get_style(line) ⇒ Integer
Get the style number for the text margin for a line.
-
#margin_get_style_offset ⇒ Integer
Get the start of the range of style numbers used for margin text.
-
#margin_get_styles(line) ⇒ String
Get the styles in the text margin for a line.
-
#margin_get_text(line) ⇒ String
Get the text in the text margin for a line.
-
#margin_set_style(line, style) ⇒ void
Set the style number for the text margin for a line.
-
#margin_set_style_offset(style) ⇒ void
Get the start of the range of style numbers used for margin text.
-
#margin_set_styles(line, styles) ⇒ void
Set the style in the text margin for a line.
-
#margin_set_text(line, text) ⇒ void
Set the text in the text margin for a line.
-
#margin_text_clear_all ⇒ void
Clear the margin text on all lines.
-
#mark_dirty ⇒ void
Mark text as modified (dirty).
-
#marker_add(line, markerNumber) ⇒ Integer
Add a marker to a line, returning an ID which can be used to find or delete the marker.
-
#marker_add_set(line, markerSet) ⇒ void
Add a set of markers to a line.
-
#marker_define(markerNumber, markerSymbol, foreground = Wx::NULL_COLOUR, background = Wx::NULL_COLOUR) ⇒ void
Set the symbol used for a particular marker number, and optionally the fore and background colours.
-
#marker_define_bitmap(markerNumber, bmp) ⇒ void
Define a marker with a Bitmap.
-
#marker_delete(line, markerNumber) ⇒ void
Delete a marker from a line.
-
#marker_delete_all(markerNumber) ⇒ void
Delete all markers with a particular number from all lines.
-
#marker_delete_handle(markerHandle) ⇒ void
Delete a marker.
-
#marker_enable_highlight(enabled) ⇒ void
Enable/disable highlight for current folding block (smallest one that contains the caret).
-
#marker_get(line) ⇒ Integer
Get a bit mask of all the markers set on a line.
-
#marker_line_from_handle(markerHandle) ⇒ Integer
Retrieve the line number at which a particular marker is located.
-
#marker_next(lineStart, markerMask) ⇒ Integer
Find the next line at or after lineStart that includes a marker in mask.
-
#marker_previous(lineStart, markerMask) ⇒ Integer
Find the previous line before lineStart that includes a marker in mask.
-
#marker_set_alpha(markerNumber, alpha) ⇒ void
Set the alpha used for a marker that is drawn in the text area, not the margin.
-
#marker_set_background(markerNumber, back) ⇒ void
Set the background colour used for a particular marker number.
-
#marker_set_background_selected(markerNumber, back) ⇒ void
Set the background colour used for a particular marker number when its folding block is selected.
-
#marker_set_foreground(markerNumber, fore) ⇒ void
Set the foreground colour used for a particular marker number.
-
#move_caret_inside_view ⇒ void
Move the caret inside current view if it’s not there already.
-
#move_selected_lines_down ⇒ void
Move the selected lines down one line, shifting the line below before the selection.
-
#move_selected_lines_up ⇒ void
Move the selected lines up one line, shifting the line above after the selection.
-
#multi_edge_add_line(column, edgeColour) ⇒ void
Add a new vertical edge to the view.
-
#multi_edge_clear_all ⇒ void
Clear all vertical edges.
-
#multiple_select_add_each ⇒ void
Add each occurrence of the main selection in the target to the set of selections.
-
#multiple_select_add_next ⇒ void
Add the next occurrence of the main selection to the set of selections as main.
-
#new_line ⇒ void
Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
-
#page_down ⇒ void
Move caret one page down.
-
#page_down_extend ⇒ void
Move caret one page down extending selection to new caret position.
-
#page_down_rect_extend ⇒ void
Move caret one page down, extending rectangular selection to new caret position.
-
#page_up ⇒ void
Move caret one page up.
-
#page_up_extend ⇒ void
Move caret one page up extending selection to new caret position.
-
#page_up_rect_extend ⇒ void
Move caret one page up, extending rectangular selection to new caret position.
-
#para_down ⇒ void
Move caret down one paragraph (delimited by empty lines).
-
#para_down_extend ⇒ void
Extend selection down one paragraph (delimited by empty lines).
-
#para_up ⇒ void
Move caret up one paragraph (delimited by empty lines).
-
#para_up_extend ⇒ void
Extend selection up one paragraph (delimited by empty lines).
-
#paste ⇒ void
Paste the contents of the clipboard into the document replacing the selection.
-
#point_from_position(pos) ⇒ Wx::Point
Retrieve the point in the window where a position is displayed.
-
#position_after(pos) ⇒ Integer
Given a valid document position, return the next position taking code page into account.
-
#position_before(pos) ⇒ Integer
Given a valid document position, return the previous position taking code page into account.
-
#position_from_line(line) ⇒ Integer
Retrieve the position at the start of a line.
-
#position_from_point(pt) ⇒ Integer
Find the position from a point within the window.
-
#position_from_point_close(x, y) ⇒ Integer
Find the position from a point within the window but return STC_INVALID_POSITION if not close to text.
-
#position_relative(pos, relative) ⇒ Integer
Given a valid document position, return a position that differs in a number of characters.
-
#position_to_xy(pos) ⇒ Array(Boolean,Array(Integer, Integer))
Converts given position to a zero-based column, line number pair.
-
#property_names ⇒ String
Retrieve a ‘n’ separated list of properties understood by the current lexer.
-
#property_type(name) ⇒ Integer
Retrieve the type of a property.
-
#redo_ ⇒ void
Redoes the next action on the undo history.
-
#register_image(type, bmp) ⇒ void
Register an image for use in autocompletion lists.
-
#release_all_extended_styles ⇒ void
Release all extended (>255) style numbers.
-
#remove(from, to) ⇒ void
Removes the text starting at the first given position up to (but not including) the character at the last position.
-
#replace(from, to, value) ⇒ void
Replaces the text starting at the first position up to (but not including) the character at the last position with the given text.
-
#replace_selection(text) ⇒ void
Replace the selected text with the argument text.
-
#replace_target(text) ⇒ Integer
Replace the target text with the argument text.
-
#replace_target_re(text) ⇒ Integer
Replace the target text with the argument text after d processing.
-
#rgba_image_set_height(height) ⇒ void
Set the height for future RGBA image data.
-
#rgba_image_set_scale(scalePercent) ⇒ void
Set the scale factor in percent for future RGBA image data.
-
#rgba_image_set_width(width) ⇒ void
Set the width for future RGBA image data.
-
#rotate_selection ⇒ void
Set the main selection to the next selection.
-
#save_file(filename) ⇒ Boolean
Write the contents of the editor to filename.
-
#scroll_range(secondary, primary) ⇒ void
Scroll the argument positions and the range between them into view giving priority to the primary position then the secondary position.
-
#scroll_to_column(column) ⇒ void
Scroll enough to make the given column visible.
-
#scroll_to_end ⇒ void
Scroll to end of document.
-
#scroll_to_line(line) ⇒ void
Scroll enough to make the given line visible.
-
#scroll_to_start ⇒ void
Scroll to start of document.
-
#search_anchor ⇒ void
Sets the current caret position to be the search anchor.
-
#search_in_target(text) ⇒ Integer
Search for a counted string in the target and set the target to the found range.
-
#search_next(searchFlags, text) ⇒ Integer
Find some text starting at the search anchor.
-
#search_prev(searchFlags, text) ⇒ Integer
Find some text starting at the search anchor and moving backwards.
-
#select_all ⇒ void
Select all the text in the document.
-
#select_none ⇒ void
Deselects selected text in the control.
-
#selection_duplicate ⇒ void
Duplicate the selection.
-
#selection_is_rectangle ⇒ Boolean
Is the selection rectangular? The alternative is the more common stream selection.
-
#send_msg(msg, wp = 0, lp = 0) ⇒ Integer
Scintilla API call.
-
#set_additional_caret_foreground(fore) ⇒ void
(also: #additional_caret_foreground=)
Set the foreground colour of additional carets.
-
#set_additional_carets_blink(additionalCaretsBlink) ⇒ void
(also: #additional_carets_blink=)
Set whether additional carets will blink.
-
#set_additional_carets_visible(additionalCaretsVisible) ⇒ void
(also: #additional_carets_visible=)
Set whether additional carets are visible.
-
#set_additional_sel_alpha(alpha) ⇒ void
(also: #additional_sel_alpha=)
Set the alpha of the selection.
-
#set_additional_sel_background(back) ⇒ void
(also: #additional_sel_background=)
Set the background colour of additional selections.
-
#set_additional_sel_foreground(fore) ⇒ void
(also: #additional_sel_foreground=)
Set the foreground colour of additional selections.
-
#set_additional_selection_typing(additionalSelectionTyping) ⇒ void
(also: #additional_selection_typing=)
Set whether typing can be performed into multiple selections.
-
#set_anchor(anchor) ⇒ void
(also: #anchor=)
Set the selection anchor to a position.
-
#set_automatic_fold(automaticFold) ⇒ void
(also: #automatic_fold=)
Set automatic folding behaviours.
-
#set_back_space_un_indents(bsUnIndents) ⇒ void
(also: #back_space_un_indents=)
Sets whether a backspace pressed when caret is within indentation unindents.
-
#set_buffered_draw(buffered) ⇒ void
(also: #buffered_draw=)
If drawing is buffered then each line of text is drawn into a bitmap buffer before drawing it to the screen to avoid flicker.
-
#set_caret_foreground(fore) ⇒ void
(also: #caret_foreground=)
Set the foreground colour of the caret.
-
#set_caret_line_back_alpha(alpha) ⇒ void
(also: #caret_line_back_alpha=)
Set background alpha of the caret line.
-
#set_caret_line_background(back) ⇒ void
(also: #caret_line_background=)
Set the colour of the background of the line containing the caret.
-
#set_caret_line_visible(show) ⇒ void
(also: #caret_line_visible=)
Display the background of the line containing the caret in a different colour.
-
#set_caret_line_visible_always(alwaysVisible) ⇒ void
(also: #caret_line_visible_always=)
Sets the caret line to always visible.
-
#set_caret_period(periodMilliseconds) ⇒ void
(also: #caret_period=)
Get the time in milliseconds that the caret is on and off.
-
#set_caret_sticky(useCaretStickyBehaviour) ⇒ void
(also: #caret_sticky=)
Stop the caret preferred x position changing when the user types.
-
#set_caret_style(caretStyle) ⇒ void
(also: #caret_style=)
Set the style of the caret to be drawn.
-
#set_caret_width(pixelWidth) ⇒ void
(also: #caret_width=)
Set the width of the insert mode caret.
-
#set_chars_default ⇒ void
Reset the set of characters for whitespace and word characters to the defaults.
-
#set_code_page(codePage) ⇒ void
(also: #code_page=)
Set the code page used to interpret the bytes of the document as characters.
-
#set_control_char_symbol(symbol) ⇒ void
(also: #control_char_symbol=)
Change the way control characters are displayed: If symbol is < 32, keep the drawn way, else, use the given character.
-
#set_current_pos(caret) ⇒ void
(also: #current_pos=)
Sets the position of the caret.
-
#set_default_style(style) ⇒ Boolean
(also: #default_style=)
This method is inherited from TextAreaBase but is not implemented in StyledTextCtrl.
-
#set_edge_colour(edgeColour) ⇒ void
(also: #edge_colour=)
Change the colour used in edge indication.
-
#set_edge_column(column) ⇒ void
(also: #edge_column=)
Set the column number of the edge.
-
#set_edge_mode(edgeMode) ⇒ void
(also: #edge_mode=)
The edge may be displayed by a line (STC_EDGE_LINE/STC_EDGE_MULTILINE) or by highlighting text that goes beyond it (STC_EDGE_BACKGROUND) or not displayed at all (STC_EDGE_NONE).
-
#set_editable(editable) ⇒ void
(also: #editable=)
Makes the text item editable or read-only, overriding the TE_READONLY flag.
-
#set_empty_selection(caret) ⇒ void
(also: #empty_selection=)
Set caret to a position, while removing any existing selection.
-
#set_end_at_last_line(endAtLastLine) ⇒ void
(also: #end_at_last_line=)
Sets the scroll range so that maximum scroll position has the last line at the bottom of the view (default).
-
#set_eol_mode(eolMode) ⇒ void
(also: #eol_mode=)
Set the current end of line mode.
-
#set_extra_ascent(extraAscent) ⇒ void
(also: #extra_ascent=)
Set extra ascent for each line.
-
#set_extra_descent(extraDescent) ⇒ void
(also: #extra_descent=)
Set extra descent for each line.
-
#set_first_visible_line(displayLine) ⇒ void
(also: #first_visible_line=)
Scroll so that a display line is at the top of the display.
-
#set_fold_expanded(line, expanded) ⇒ void
Show the children of a header line.
-
#set_fold_flags(flags) ⇒ void
(also: #fold_flags=)
Set some style options for folding.
-
#set_fold_level(line, level) ⇒ void
Set the fold level of a line.
-
#set_fold_margin_colour(useSetting, back) ⇒ void
Set one of the colours used as a chequerboard pattern in the fold margin.
-
#set_fold_margin_hi_colour(useSetting, fore) ⇒ void
Set the other colour used as a chequerboard pattern in the fold margin.
-
#set_font_quality(fontQuality) ⇒ void
(also: #font_quality=)
Choose the quality level for text.
-
#set_h_scroll_bar(bar) ⇒ void
(also: #h_scroll_bar=)
Set the horizontal scrollbar to use instead of the one that’s built-in.
-
#set_highlight_guide(column) ⇒ void
(also: #highlight_guide=)
Set the highlighted indentation guide column.
-
#set_hotspot_active_background(useSetting, back) ⇒ void
Set a back colour for active hotspots.
-
#set_hotspot_active_foreground(useSetting, fore) ⇒ void
Set a fore colour for active hotspots.
-
#set_hotspot_active_underline(underline) ⇒ void
(also: #hotspot_active_underline=)
Enable / Disable underlining active hotspots.
-
#set_hotspot_single_line(singleLine) ⇒ void
(also: #hotspot_single_line=)
Limit hotspots to single line so hotspots on two lines don’t merge.
-
#set_identifier(identifier) ⇒ void
(also: #identifier=)
Set the identifier reported as idFrom in notification messages.
-
#set_identifiers(style, identifiers) ⇒ void
Set the identifiers that are shown in a particular style.
-
#set_idle_styling(idleStyling) ⇒ void
(also: #idle_styling=)
Sets limits to idle styling.
-
#set_ime_interaction(imeInteraction) ⇒ void
(also: #ime_interaction=)
Choose to display the IME in a winow or inline.
-
#set_indent(indentSize) ⇒ void
(also: #indent=)
Set the number of spaces used for one level of indentation.
-
#set_indentation_guides(indentView) ⇒ void
(also: #indentation_guides=)
Show or hide indentation guides.
-
#set_indicator_current(indicator) ⇒ void
(also: #indicator_current=)
Set the indicator used for IndicatorFillRange and IndicatorClearRange.
-
#set_indicator_value(value) ⇒ void
(also: #indicator_value=)
Set the value used for IndicatorFillRange.
-
#set_insertion_point(pos) ⇒ void
(also: #insertion_point=)
Sets the insertion point at the given position.
-
#set_key_words(keyWordSet, keyWords) ⇒ void
Set up the key words used by the lexer.
-
#set_last_keydown_processed(val) ⇒ void
(also: #last_keydown_processed=)
Returns the line number of the line with the caret.
-
#set_layout_cache(cacheMode) ⇒ void
(also: #layout_cache=)
Sets the degree of caching of layout information.
-
#set_lexer(lexer) ⇒ void
(also: #lexer=)
Set the lexing language of the document.
-
#set_lexer_language(language) ⇒ void
(also: #lexer_language=)
Set the lexing language of the document based on string name.
-
#set_line_end_types_allowed(lineEndBitSet) ⇒ void
(also: #line_end_types_allowed=)
Set the line end types that the application wants to use.
-
#set_line_indentation(line, indentation) ⇒ void
Change the indentation of a line to a number of columns.
-
#set_line_state(line, state) ⇒ void
Used to hold extra styling information for each line.
-
#set_main_selection(selection) ⇒ void
(also: #main_selection=)
Set the main selection.
-
#set_margin_background(margin, back) ⇒ void
Set the background colour of a margin.
-
#set_margin_count(margins) ⇒ void
(also: #margin_count=)
Allocate a non-standard number of margins.
-
#set_margin_cursor(margin, cursor) ⇒ void
Set the cursor shown when the mouse is inside a margin.
-
#set_margin_left(pixelWidth) ⇒ void
(also: #margin_left=)
Sets the size in pixels of the left margin.
-
#set_margin_mask(margin, mask) ⇒ void
Set a mask that determines which markers are displayed in a margin.
-
#set_margin_options(marginOptions) ⇒ void
(also: #margin_options=)
Set the margin options.
-
#set_margin_right(pixelWidth) ⇒ void
(also: #margin_right=)
Sets the size in pixels of the right margin.
-
#set_margin_sensitive(margin, sensitive) ⇒ void
Make a margin sensitive or insensitive to mouse clicks.
-
#set_margin_type(margin, marginType) ⇒ void
Set a margin to be either numeric or symbolic.
-
#set_margin_width(margin, pixelWidth) ⇒ void
Set the width of a margin to a width expressed in pixels.
-
#set_margins(left, right) ⇒ void
Set the left and right margin in the edit area, measured in pixels.
-
#set_mod_event_mask(eventMask) ⇒ void
(also: #mod_event_mask=)
Set which document modification events are sent to the container.
-
#set_mouse_down_captures(captures) ⇒ void
(also: #mouse_down_captures=)
Set whether the mouse is captured when its button is pressed.
-
#set_mouse_dwell_time(periodMilliseconds) ⇒ void
(also: #mouse_dwell_time=)
Sets the time the mouse must sit still to generate a mouse dwell event.
-
#set_mouse_selection_rectangular_switch(mouseSelectionRectangularSwitch) ⇒ void
(also: #mouse_selection_rectangular_switch=)
Set whether switching to rectangular mode while selecting with the mouse is allowed.
-
#set_mouse_wheel_captures(captures) ⇒ void
(also: #mouse_wheel_captures=)
Set whether the mouse wheel can be active outside the window.
-
#set_multi_paste(multiPaste) ⇒ void
(also: #multi_paste=)
Change the effect of pasting when there are multiple selections.
-
#set_multiple_selection(multipleSelection) ⇒ void
(also: #multiple_selection=)
Set whether multiple selections can be made.
-
#set_overtype(overType) ⇒ void
(also: #overtype=)
Set to overtype (true) or insert mode.
-
#set_paste_convert_endings(convert) ⇒ void
(also: #paste_convert_endings=)
Enable/Disable convert-on-paste for line endings.
-
#set_phases_draw(phases) ⇒ void
(also: #phases_draw=)
In one phase draw, text is drawn in a series of rectangular blocks with no overlap.
-
#set_position_cache_size(size) ⇒ void
(also: #position_cache_size=)
Set number of entries in position cache.
-
#set_print_colour_mode(mode) ⇒ void
(also: #print_colour_mode=)
Modify colours when printing for clearer printed text.
-
#set_print_magnification(magnification) ⇒ void
(also: #print_magnification=)
Sets the print magnification added to the point size of each style for printing.
-
#set_print_wrap_mode(wrapMode) ⇒ void
(also: #print_wrap_mode=)
Set printing to line wrapped (STC_WRAP_WORD) or not line wrapped (STC_WRAP_NONE).
-
#set_property(key, value) ⇒ void
Set up a value that may be used by a lexer for some optional feature.
-
#set_punctuation_chars(characters) ⇒ void
(also: #punctuation_chars=)
Set the set of characters making up punctuation characters Should be called after SetWordChars.
-
#set_read_only(readOnly) ⇒ void
(also: #read_only=)
Set to read only or read write.
-
#set_rectangular_selection_anchor(anchor) ⇒ void
(also: #rectangular_selection_anchor=)
Set the anchor position of the rectangular selection.
-
#set_rectangular_selection_anchor_virtual_space(space) ⇒ void
(also: #rectangular_selection_anchor_virtual_space=)
Set the virtual space of the anchor of the rectangular selection.
-
#set_rectangular_selection_caret(caret) ⇒ void
(also: #rectangular_selection_caret=)
Set the caret position of the rectangular selection.
-
#set_rectangular_selection_caret_virtual_space(space) ⇒ void
(also: #rectangular_selection_caret_virtual_space=)
Set the virtual space of the caret of the rectangular selection.
-
#set_rectangular_selection_modifier(modifier) ⇒ void
(also: #rectangular_selection_modifier=)
On GTK+, allow selecting the modifier key to use for mouse-based rectangular selection.
-
#set_representation(encodedCharacter, representation) ⇒ void
Set the way a character is drawn.
-
#set_save_point ⇒ void
Remember the current position in the undo history as the position at which the document was saved.
-
#set_scroll_width(pixelWidth) ⇒ void
(also: #scroll_width=)
Sets the document width assumed for scrolling.
-
#set_scroll_width_tracking(tracking) ⇒ void
(also: #scroll_width_tracking=)
Sets whether the maximum width line displayed is used to set scroll width.
-
#set_search_flags(searchFlags) ⇒ void
(also: #search_flags=)
Set the search flags used by SearchInTarget.
-
#set_sel_alpha(alpha) ⇒ void
(also: #sel_alpha=)
Set the alpha of the selection.
-
#set_sel_background(useSetting, back) ⇒ void
Set the background colour of the main and additional selections and whether to use this setting.
-
#set_sel_eol_filled(filled) ⇒ void
(also: #sel_eol_filled=)
Set the selection to have its end of line filled or not.
-
#set_sel_foreground(useSetting, fore) ⇒ void
Set the foreground colour of the main and additional selections and whether to use this setting.
-
#set_selection(from, to) ⇒ void
Selects the text starting at the first position up to (but not including) the character at the last position.
-
#set_selection_end(caret) ⇒ void
(also: #selection_end=)
Sets the position that ends the selection - this becomes the caret.
-
#set_selection_mode(selectionMode) ⇒ void
(also: #selection_mode=)
Set the selection mode to stream (STC_SEL_STREAM) or rectangular (STC_SEL_RECTANGLE/STC_SEL_THIN) or by lines (STC_SEL_LINES).
-
#set_selection_n_anchor(selection, anchor) ⇒ void
Set the anchor position of the nth selection.
-
#set_selection_n_anchor_virtual_space(selection, space) ⇒ void
Set the virtual space of the anchor of the nth selection.
-
#set_selection_n_caret(selection, caret) ⇒ void
Set the caret position of the nth selection.
-
#set_selection_n_caret_virtual_space(selection, space) ⇒ void
Set the virtual space of the caret of the nth selection.
-
#set_selection_n_end(selection, caret) ⇒ void
Sets the position that ends the selection - this becomes the currentPosition.
-
#set_selection_n_start(selection, anchor) ⇒ void
Sets the position that starts the selection - this becomes the anchor.
-
#set_selection_start(anchor) ⇒ void
(also: #selection_start=)
Sets the position that starts the selection - this becomes the anchor.
-
#set_status(status) ⇒ void
(also: #status=)
Change error status - 0 = OK.
-
#set_stc_cursor(cursorType) ⇒ void
(also: #stc_cursor=)
Sets the cursor to one of the Wx::STC_CURSOR* values.
-
#set_stc_focus(focus) ⇒ void
(also: #stc_focus=)
Change internal focus flag.
-
#set_style(start, end_, style) ⇒ Boolean
This method is inherited from TextAreaBase but is not implemented in StyledTextCtrl.
-
#set_styling(length, style) ⇒ void
Change style from current styling position for length characters to a style and move the current styling position to after this newly styled segment.
-
#set_tab_draw_mode(tabDrawMode) ⇒ void
(also: #tab_draw_mode=)
Set how tabs are drawn when visible.
-
#set_tab_indents(tabIndents) ⇒ void
(also: #tab_indents=)
Sets whether a tab pressed when caret is within indentation indents.
-
#set_tab_width(tabWidth) ⇒ void
(also: #tab_width=)
Change the visible size of a tab to be a multiple of the width of a space character.
-
#set_target_end(end_) ⇒ void
(also: #target_end=)
Sets the position that ends the target which is used for updating the document without affecting the scroll position.
-
#set_target_range(start, end_) ⇒ void
Sets both the start and end of the target in one call.
-
#set_target_start(start) ⇒ void
(also: #target_start=)
Sets the position that starts the target which is used for updating the document without affecting the scroll position.
-
#set_technology(technology) ⇒ void
(also: #technology=)
Set the technology used.
-
#set_text(text) ⇒ void
(also: #text=)
Replace the contents of the document with the argument text.
-
#set_two_phase_draw(twoPhase) ⇒ void
(also: #two_phase_draw=)
In twoPhaseDraw mode, drawing is performed in two phases, first the background and then the foreground.
-
#set_undo_collection(collectUndo) ⇒ void
(also: #undo_collection=)
Choose between collecting actions into the undo history and discarding them.
-
#set_use_anti_aliasing(useAA) ⇒ void
(also: #use_anti_aliasing=)
Specify whether anti-aliased fonts should be used.
-
#set_use_horizontal_scroll_bar(visible) ⇒ void
(also: #use_horizontal_scroll_bar=)
Show or hide the horizontal scroll bar.
-
#set_use_tabs(useTabs) ⇒ void
(also: #use_tabs=)
Indentation will only use space characters if useTabs is false, otherwise it will use a combination of tabs and spaces.
-
#set_use_vertical_scroll_bar(visible) ⇒ void
(also: #use_vertical_scroll_bar=)
Show or hide the vertical scroll bar.
-
#set_v_scroll_bar(bar) ⇒ void
(also: #v_scroll_bar=)
Set the vertical scrollbar to use instead of the one that’s built-in.
-
#set_view_eol(visible) ⇒ void
(also: #view_eol=)
Make the end of line characters visible or invisible.
-
#set_view_white_space(viewWS) ⇒ void
(also: #view_white_space=)
Make white space characters invisible, always visible or visible outside indentation.
-
#set_virtual_space_options(virtualSpaceOptions) ⇒ void
(also: #virtual_space_options=)
Set options for virtual space behaviour.
-
#set_visible_policy(visiblePolicy, visibleSlop) ⇒ void
Set the way the display area is determined when a particular line is to be moved to by Find, FindNext, GotoLine, etc.
-
#set_whitespace_background(useSetting, back) ⇒ void
Set the background colour of all whitespace and whether to use this setting.
-
#set_whitespace_chars(characters) ⇒ void
(also: #whitespace_chars=)
Set the set of characters making up whitespace for when moving or selecting by word.
-
#set_whitespace_foreground(useSetting, fore) ⇒ void
Set the foreground colour of all whitespace and whether to use this setting.
-
#set_whitespace_size(size) ⇒ void
(also: #whitespace_size=)
Set the size of the dots used to mark space characters.
-
#set_word_chars(characters) ⇒ void
(also: #word_chars=)
Set the set of characters making up words for when moving or selecting by word.
-
#set_wrap_indent_mode(wrapIndentMode) ⇒ void
(also: #wrap_indent_mode=)
Sets how wrapped sublines are placed.
-
#set_wrap_mode(wrapMode) ⇒ void
(also: #wrap_mode=)
Sets whether text is word wrapped.
-
#set_wrap_start_indent(indent) ⇒ void
(also: #wrap_start_indent=)
Set the start indent for wrapped lines.
-
#set_wrap_visual_flags(wrapVisualFlags) ⇒ void
(also: #wrap_visual_flags=)
Set the display mode of visual flags for wrapped lines.
-
#set_wrap_visual_flags_location(wrapVisualFlagsLocation) ⇒ void
(also: #wrap_visual_flags_location=)
Set the location of visual flags for wrapped lines.
-
#set_x_caret_policy(caretPolicy, caretSlop) ⇒ void
Set the way the caret is kept visible when going sideways.
-
#set_x_offset(xOffset) ⇒ void
(also: #x_offset=)
Set the xOffset (ie, horizontal scroll position).
-
#set_y_caret_policy(caretPolicy, caretSlop) ⇒ void
Set the way the line the caret is on is kept visible.
-
#set_zoom(zoomInPoints) ⇒ void
(also: #zoom=)
Set the zoom level.
-
#show_lines(lineStart, lineEnd) ⇒ void
Make a range of lines visible.
-
#show_position(pos) ⇒ void
Makes the line containing the given position visible.
-
#start_record ⇒ void
Start notifying the container of all key presses and commands.
-
#start_styling(start) ⇒ void
Set the current styling position to start.
-
#stop_record ⇒ void
Stop notifying the container of all key presses and commands.
-
#stuttered_page_down ⇒ void
Move caret to bottom of page, or one page down if already at bottom of page.
-
#stuttered_page_down_extend ⇒ void
Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.
-
#stuttered_page_up ⇒ void
Move caret to top of page, or one page up if already at top of page.
-
#stuttered_page_up_extend ⇒ void
Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.
-
#style_clear_all ⇒ void
Clear all the styles and make equivalent to the global default style.
-
#style_get_background(style) ⇒ Wx::Colour
Get the background colour of a style.
-
#style_get_bold(style) ⇒ Boolean
Get is a style bold or not.
-
#style_get_case(style) ⇒ Integer
Get is a style mixed case, or to force upper or lower case.
-
#style_get_changeable(style) ⇒ Boolean
Get is a style changeable or not (read only).
-
#style_get_character_set(style) ⇒ Integer
Get the character get of the font in a style.
-
#style_get_eol_filled(style) ⇒ Boolean
Get is a style to have its end of line filled or not.
-
#style_get_face_name(style) ⇒ String
Get the font facename of a style.
-
#style_get_font(style) ⇒ Wx::Font
Get the font of a style.
-
#style_get_foreground(style) ⇒ Wx::Colour
Get the foreground colour of a style.
-
#style_get_hot_spot(style) ⇒ Boolean
Get is a style a hotspot or not.
-
#style_get_italic(style) ⇒ Boolean
Get is a style italic or not.
-
#style_get_size(style) ⇒ Integer
Get the size of characters of a style.
-
#style_get_size_fractional(style) ⇒ Integer
Get the size of characters of a style in points multiplied by 100.
-
#style_get_underline(style) ⇒ Boolean
Get is a style underlined or not.
-
#style_get_visible(style) ⇒ Boolean
Get is a style visible or not.
-
#style_get_weight(style) ⇒ Integer
Get the weight of characters of a style.
-
#style_reset_default ⇒ void
Reset the default style to its state at startup.
-
#style_set_background(style, back) ⇒ void
Set the background colour of a style.
-
#style_set_bold(style, bold) ⇒ void
Set a style to be bold or not.
-
#style_set_case(style, caseVisible) ⇒ void
Set a style to be mixed case, or to force upper or lower case.
-
#style_set_changeable(style, changeable) ⇒ void
Set a style to be changeable or not (read only).
-
#style_set_character_set(style, characterSet) ⇒ void
Set the character set of the font in a style.
-
#style_set_eol_filled(style, eolFilled) ⇒ void
Set a style to have its end of line filled or not.
-
#style_set_face_name(style, fontName) ⇒ void
Set the font of a style.
-
#style_set_font(styleNum, font) ⇒ void
Set style size, face, bold, italic, and underline attributes from a Font‘s attributes.
-
#style_set_font_attr(styleNum, size, faceName, bold, italic, underline, encoding = Wx::FontEncoding::FONTENCODING_DEFAULT) ⇒ void
Set all font style attributes at once.
-
#style_set_font_encoding(style, encoding) ⇒ void
Set the font encoding to be used by a style.
-
#style_set_foreground(style, fore) ⇒ void
Set the foreground colour of a style.
-
#style_set_hot_spot(style, hotspot) ⇒ void
Set a style to be a hotspot or not.
-
#style_set_italic(style, italic) ⇒ void
Set a style to be italic or not.
-
#style_set_size(style, sizePoints) ⇒ void
Set the size of characters of a style.
-
#style_set_size_fractional(style, sizeHundredthPoints) ⇒ void
Set the size of characters of a style.
-
#style_set_spec(styleNum, spec) ⇒ void
Extract style settings from a spec-string which is composed of one or more of the following comma separated elements:.
-
#style_set_underline(style, underline) ⇒ void
Set a style to be underlined or not.
-
#style_set_visible(style, visible) ⇒ void
Set a style to be visible or not.
-
#style_set_weight(style, weight) ⇒ void
Set the weight of characters of a style.
-
#swap_main_anchor_caret ⇒ void
Swap that caret and anchor of the main selection.
-
#tab ⇒ void
If selection is empty or all on one line replace the selection with a tab character.
-
#target_from_selection ⇒ void
Make the target range start and end be the same as the selection range start and end.
-
#target_whole_document ⇒ void
Sets the target to the whole document.
-
#text_height(line) ⇒ Integer
Retrieve the height of a particular line of text in pixels.
-
#text_width(style, text) ⇒ Integer
Measure the pixel width of some text in a particular style.
-
#toggle_caret_sticky ⇒ void
Switch between sticky and non-sticky: meant to be bound to a key.
-
#toggle_fold(line) ⇒ void
Switch a header line between expanded and contracted.
-
#toggle_fold_show_text(line, text) ⇒ void
Switch a header line between expanded and contracted and show some text after the line.
-
#undo ⇒ void
Undo one action in the undo history.
-
#upper_case ⇒ void
Transform the selection to upper case.
-
#use_pop_up(popUpMode) ⇒ void
Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button on certain areas.
-
#user_list_show(listType, itemList) ⇒ void
Display a list of strings and send notification when user chooses one.
-
#vc_home ⇒ void
Move caret to before first visible character on line.
-
#vc_home_display ⇒ void
Move caret to before first visible character on display line.
-
#vc_home_display_extend ⇒ void
Like VCHomeDisplay but extending selection to new caret position.
-
#vc_home_extend ⇒ void
Like VCHome but extending selection to new caret position.
-
#vc_home_rect_extend ⇒ void
Move caret to before first visible character on line.
-
#vc_home_wrap ⇒ void
Like VCHome but when word-wrap is enabled goes first to start of display line VCHomeDisplay, then behaves like VCHome.
-
#vc_home_wrap_extend ⇒ void
Like VCHomeExtend but when word-wrap is enabled extends first to start of display line VCHomeDisplayExtend, then behaves like VCHomeExtend.
-
#vertical_centre_caret ⇒ void
Centre current line in window.
-
#visible_from_doc_line(docLine) ⇒ Integer
Find the display line of a document line taking hidden lines into account.
-
#word_end_position(pos, onlyWordCharacters) ⇒ Integer
Get position of end of word.
-
#word_left ⇒ void
Move caret left one word.
-
#word_left_end ⇒ void
Move caret left one word, position cursor at end of word.
-
#word_left_end_extend ⇒ void
Move caret left one word, position cursor at end of word, extending selection to new caret position.
-
#word_left_extend ⇒ void
Move caret left one word extending selection to new caret position.
-
#word_part_left ⇒ void
Move to the previous change in capitalisation.
-
#word_part_left_extend ⇒ void
Move to the previous change in capitalisation extending selection to new caret position.
-
#word_part_right ⇒ void
Move to the change next in capitalisation.
-
#word_part_right_extend ⇒ void
Move to the next change in capitalisation extending selection to new caret position.
-
#word_right ⇒ void
Move caret right one word.
-
#word_right_end ⇒ void
Move caret right one word, position cursor at end of word.
-
#word_right_end_extend ⇒ void
Move caret right one word, position cursor at end of word, extending selection to new caret position.
-
#word_right_extend ⇒ void
Move caret right one word extending selection to new caret position.
-
#word_start_position(pos, onlyWordCharacters) ⇒ Integer
Get position of start of word.
-
#wrap_count(docLine) ⇒ Integer
The number of display lines needed to wrap a document line.
-
#write_text(text) ⇒ void
Writes the text into the text control at the current insertion position.
-
#xy_to_position(x, y) ⇒ Integer
Converts the given zero based column and line number to a position.
-
#zoom_in ⇒ void
Magnify the displayed text by increasing the sizes by 1 point.
-
#zoom_out ⇒ void
Make the displayed text smaller by decreasing the sizes by 1 point.
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_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_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, #navigate, #navigate_in, new_control_id, #on_internal_idle, #paint, #paint_buffered, #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_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_display_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_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_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_capture_changed, #evt_mouse_capture_lost, #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_command, #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, #set_previous_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 ⇒ Wx::STC::StyledTextCtrl
Returns a new instance of StyledTextCtrl.
92 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 92 def initialize(*args) end |
Class Method Details
.get_library_version_info ⇒ Wx::VersionInfo
Returns the version of the Scintilla library used by this control.
4206 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4206 def self.get_library_version_info; end |
Instance Method Details
#add_selection(caret, anchor) ⇒ Integer
Add a selection.
806 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 806 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.
2262 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2262 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.
109 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 109 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.
456 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 456 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.
201 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 201 def allocate(bytes) end |
#allocate_extended_styles(numberStyles) ⇒ Integer
Allocate some extended (>255) style numbers and return the start of the range.
210 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 210 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.
3773 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3773 def allocate_sub_styles(styleBase, numberStyles) end |
#annotation_clear_all ⇒ void
This method returns an undefined value.
Clear the annotations from all lines.
2063 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2063 def annotation_clear_all; end |
#annotation_clear_line(line) ⇒ void
This method returns an undefined value.
Clear annotations from the given line.
4002 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4002 def annotation_clear_line(line) end |
#annotation_get_lines(line) ⇒ Integer
Get the number of annotation lines for a line.
2059 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2059 def annotation_get_lines(line) end |
#annotation_get_style(line) ⇒ Integer
Get the style number for the annotations for a line.
2043 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2043 def annotation_get_style(line) end |
#annotation_get_style_offset ⇒ Integer
Get the start of the range of style numbers used for annotations.
2085 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2085 def annotation_get_style_offset; end |
#annotation_get_styles(line) ⇒ String
Get the annotation styles for a line.
2054 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2054 def annotation_get_styles(line) end |
#annotation_get_text(line) ⇒ String
Get the annotation text for a line.
2032 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2032 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.
2076 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2076 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.
2038 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2038 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.
2081 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2081 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.
2049 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2049 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.
2027 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2027 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.
2070 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2070 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.
196 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 196 def append_text(text) end |
#auto_comp_active ⇒ Boolean
Is there an auto-completion list visible?
2642 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2642 def auto_comp_active; end |
#auto_comp_cancel ⇒ void
This method returns an undefined value.
Remove the auto-completion list from the screen.
2638 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2638 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.
2650 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2650 def auto_comp_complete; end |
#auto_comp_get_auto_hide ⇒ Boolean
Retrieve whether or not autocompletion is hidden automatically when nothing matches.
2712 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2712 def auto_comp_get_auto_hide; end |
#auto_comp_get_cancel_at_start ⇒ Boolean
Retrieve whether auto-completion cancelled by backspacing before start.
2680 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2680 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.
2785 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2785 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.
2694 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2694 def auto_comp_get_choose_single; end |
#auto_comp_get_current ⇒ Integer
Get currently selected item position in the auto-completion list.
2768 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2768 def auto_comp_get_current; end |
#auto_comp_get_current_text ⇒ String
Get currently selected item text in the auto-completion list.
2772 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2772 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.
2721 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2721 def auto_comp_get_drop_rest_of_word; end |
#auto_comp_get_ignore_case ⇒ Boolean
Retrieve state of ignore case flag.
2703 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2703 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.
2764 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2764 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.
2753 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2753 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.
2798 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2798 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.
2811 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2811 def auto_comp_get_order; end |
#auto_comp_get_separator ⇒ Integer
Retrieve the auto-completion list separator character.
2666 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2666 def auto_comp_get_separator; end |
#auto_comp_get_type_separator ⇒ Integer
Retrieve the auto-completion list type-separator character.
2735 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2735 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.
2646 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2646 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.
2671 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2671 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.
2708 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2708 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.
2676 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2676 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.
2779 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2779 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.
2690 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2690 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.
2717 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2717 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.
2685 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2685 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.
2699 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2699 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.
2760 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2760 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.
2749 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2749 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.
2792 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2792 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.
2805 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2805 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.
2662 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2662 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 ‘?’.
2742 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2742 def auto_comp_set_type_separator(separatorCharacter) end |
#auto_comp_show(lengthEntered, itemList) ⇒ void
This method returns an undefined value.
Display an auto-completion list.
The lengthEntered parameter indicates how many characters before the caret should be used to provide context.
2634 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2634 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.
2655 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2655 def auto_comp_stops(characterSet) end |
#back_tab ⇒ void
This method returns an undefined value.
Dedent the selected lines.
2989 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2989 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.
431 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 431 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.
2226 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2226 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.
2232 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2232 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.
2215 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2215 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.
2221 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2221 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.
2240 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2240 def brace_match(pos, maxReStyle=0) end |
#call_tip_active ⇒ Boolean
Is there an active call tip?
2831 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2831 def call_tip_active; end |
#call_tip_cancel ⇒ void
This method returns an undefined value.
Remove the call tip from the screen.
2827 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2827 def call_tip_cancel; end |
#call_tip_pos_at_start ⇒ Integer
Retrieve the position where the caret was before displaying the call tip.
2835 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2835 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.
2851 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2851 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.
2856 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2856 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.
2861 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2861 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.
2846 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2846 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.
2840 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2840 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.
2871 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2871 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.
2823 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2823 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.
2866 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2866 def call_tip_use_style(tabSize) end |
#can_paste ⇒ Boolean Also known as: can_paste?
Will a paste succeed?
344 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 344 def can_paste; end |
#can_redo ⇒ Boolean Also known as: can_redo?
Are there any redoable actions in the undo history?
419 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 419 def can_redo; end |
#can_undo ⇒ Boolean Also known as: can_undo?
Are there any undoable actions in the undo history?
439 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 439 def can_undo; end |
#cancel ⇒ void
This method returns an undefined value.
Cancel any modes such as call tip or auto-completion list display.
2975 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2975 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.
121 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 121 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.
3679 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3679 def change_lexer_state(start, end_) end |
#char_left ⇒ void
This method returns an undefined value.
Move caret left one character.
2891 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2891 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.
2895 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2895 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.
3153 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3153 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.
700 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 700 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.
708 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 708 def char_position_from_point_close(x, y) end |
#char_right ⇒ void
This method returns an undefined value.
Move caret right one character.
2899 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2899 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.
2903 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2903 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.
3157 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3157 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.
639 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 639 def choose_caret_x; end |
#clear ⇒ void
This method returns an undefined value.
Clear the selection.
361 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 361 def clear; end |
#clear_all ⇒ void
This method returns an undefined value.
Delete all text in the document.
125 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 125 def clear_all; end |
#clear_document_style ⇒ void
This method returns an undefined value.
Set all style bytes to 0, remove all folding information.
135 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 135 def clear_document_style; end |
#clear_registered_images ⇒ void
This method returns an undefined value.
Clear all the registered images.
2731 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2731 def clear_registered_images; end |
#clear_representation(encodedCharacter) ⇒ void
This method returns an undefined value.
Remove a character representation.
1833 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1833 def clear_representation(encodedCharacter) end |
#clear_selections ⇒ void
This method returns an undefined value.
Clear selections to a single empty stream selection.
800 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 800 def clear_selections; end |
#clear_tab_stops(line) ⇒ void
This method returns an undefined value.
Clear explicit tabstops on a line.
2256 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2256 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.
3248 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3248 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.
3256 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3256 def cmd_key_clear(key, modifiers) end |
#cmd_key_clear_all ⇒ void
This method returns an undefined value.
Drop all key mappings.
3260 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3260 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.
3903 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3903 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.
3700 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3700 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.
3498 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3498 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.
1262 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1262 def convert_eo_ls(eolMode) end |
#copy ⇒ void
This method returns an undefined value.
Copy the selection to the clipboard.
353 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 353 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.
390 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 390 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.
369 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 369 def copy_range(start, end_) end |
#copy_text(length, text) ⇒ void
This method returns an undefined value.
Copy argument text to the clipboard.
375 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 375 def copy_text(length, text) end |
#count_characters(start, end_) ⇒ Integer
Count characters between two positions.
523 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 523 def count_characters(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.)
104 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 104 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.
349 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 349 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.
3121 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3121 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.
3125 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3125 def del_line_right; end |
#del_word_left ⇒ void
This method returns an undefined value.
Delete the word to the left of the caret.
3011 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3011 def del_word_left; end |
#del_word_right ⇒ void
This method returns an undefined value.
Delete the word to the right of the caret.
3015 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3015 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.
3019 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3019 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.
2979 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2979 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.
3057 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3057 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.
131 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 131 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.
3767 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3767 def describe_key_word_sets; end |
#describe_property(name) ⇒ String
Describe a property.
3763 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3763 def describe_property(name) end |
#discard_edits ⇒ void
This method returns an undefined value.
Resets the internal modified flag as if the current changes had been saved.
4151 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4151 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.
3811 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3811 def distance_to_secondary_styles; end |
#do_drag_enter(x, y, defaultRes) ⇒ Wx::DragResult
Allow for simulating a DnD DragEnter.
3966 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3966 def do_drag_enter(x, y, defaultRes) end |
#do_drag_leave ⇒ void
This method returns an undefined value.
Allow for simulating a DnD DragLeave.
3977 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3977 def do_drag_leave; end |
#do_drag_over(x, y, defaultRes) ⇒ Wx::DragResult
Allow for simulating a DnD DragOver.
3973 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3973 def do_drag_over(x, y, defaultRes) end |
#do_drop_text(x, y, data) ⇒ Boolean
Allow for simulating a DnD DropText.
3984 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3984 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.
3345 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3345 def doc_line_from_visible(displayLine) end |
#document_end ⇒ void
This method returns an undefined value.
Move caret to last position in document.
2947 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2947 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.
2951 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2951 def document_end_extend; end |
#document_start ⇒ void
This method returns an undefined value.
Move caret to first position in document.
2939 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2939 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.
2943 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2943 def document_start_extend; end |
#drop_selection_n(selection) ⇒ void
This method returns an undefined value.
Drop one selection.
811 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 811 def drop_selection_n(selection) end |
#each_line {|line| ... } ⇒ Object, Enumerator
Yield each line to the given block. Returns an Enumerator if no block given.
18 |
# File 'lib/wx/doc/stc/styled_text_ctrl.rb', line 18 def each_line; end |
#edit_toggle_overtype ⇒ void
This method returns an undefined value.
Switch from insert to overtype mode or the reverse.
2971 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2971 def edit_toggle_overtype; end |
#empty_undo_buffer ⇒ void
This method returns an undefined value.
Delete the undo history.
444 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 444 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.
435 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 435 def end_undo_action; end |
#ensure_caret_visible ⇒ void
This method returns an undefined value.
Ensure the caret is visible.
1052 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1052 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.
3461 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3461 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.
3491 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3491 def ensure_visible_enforce_policy(line) 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.
3449 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3449 def (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.
694 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 694 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.
A backwards search can be performed by setting minPos to be greater than maxPos.
226 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 226 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.
3456 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3456 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.
3441 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3441 def fold_children(line, action) 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.
3425 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3425 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.
3433 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3433 def fold_line(line, action) end |
#form_feed ⇒ void
This method returns an undefined value.
Insert a Form Feed character.
2997 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2997 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.
3317 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3317 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.
3801 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3801 def free_sub_styles; end |
#get_additional_caret_foreground ⇒ Wx::Colour Also known as: additional_caret_foreground
Get the foreground colour of additional carets.
1005 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1005 def get_additional_caret_foreground; end |
#get_additional_carets_blink ⇒ Boolean Also known as: additional_carets_blink
Whether additional carets will blink.
774 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 774 def get_additional_carets_blink; end |
#get_additional_carets_visible ⇒ Boolean Also known as: additional_carets_visible
Whether additional carets are visible.
785 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 785 def get_additional_carets_visible; end |
#get_additional_sel_alpha ⇒ Integer Also known as: additional_sel_alpha
Get the alpha of the selection.
994 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 994 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.
763 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 763 def get_additional_selection_typing; end |
#get_all_lines_visible ⇒ Boolean Also known as: all_lines_visible
Are all lines visible?
3394 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3394 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.
470 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 470 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.
3475 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3475 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?
2358 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2358 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?
2089 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2089 def get_buffered_draw; end |
#get_caret_foreground ⇒ Wx::Colour Also known as: caret_foreground
Get the foreground colour of the caret.
1693 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1693 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.
1778 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1778 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.
1682 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1682 def get_caret_line_background; 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?
1671 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1671 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?
1798 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1798 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.
1658 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1658 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.
1755 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1755 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.
1793 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1793 def get_caret_style; end |
#get_caret_width ⇒ Integer Also known as: caret_width
Returns the width of the insert mode caret.
1704 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1704 def get_caret_width; end |
#get_char_at(pos) ⇒ Integer Also known as: char_at
Returns the character byte at the position.
140 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 140 def get_char_at(pos) end |
#get_code_page ⇒ Integer Also known as: code_page
Get the code page used to interpret the bytes of the document as characters.
2121 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2121 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.
516 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 516 def get_column(pos) end |
#get_control_char_symbol ⇒ Integer Also known as: control_char_symbol
Get the way control characters are displayed.
1815 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1815 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.
510 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 510 def get_cur_line; end |
#get_current_line ⇒ Integer Also known as: current_line
Returns the line number of the line with the caret.
3861 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3861 def get_current_line; end |
#get_current_pos ⇒ Integer Also known as: current_pos
Returns the position of the caret.
465 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 465 def get_current_pos; end |
#get_edge_colour ⇒ Wx::Colour Also known as: edge_colour
Retrieve the colour used in edge indication.
3656 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3656 def get_edge_colour; end |
#get_edge_column ⇒ Integer Also known as: edge_column
Retrieve the column number which text should be kept within.
3628 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3628 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.
3643 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3643 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.
1094 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1094 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.
1381 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1381 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.
1266 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1266 def get_eol_mode; end |
#get_extra_ascent ⇒ Integer Also known as: extra_ascent
Get extra ascent for each line.
1210 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1210 def get_extra_ascent; end |
#get_extra_descent ⇒ Integer Also known as: extra_descent
Get extra descent for each line.
1221 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1221 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.
1041 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1041 def get_first_visible_line; end |
#get_fold_expanded(line) ⇒ Boolean Also known as: fold_expanded
Is a header line expanded?
3406 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3406 def (line) end |
#get_fold_level(line) ⇒ Integer Also known as: fold_level
Retrieve the fold level of a line.
3358 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3358 def get_fold_level(line) end |
#get_fold_parent(line) ⇒ Integer Also known as: fold_parent
Find the parent line of a child line.
3371 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3371 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.
2178 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2178 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.
3334 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3334 def get_gap_position; end |
#get_highlight_guide ⇒ Integer Also known as: highlight_guide
Get the highlighted indentation guide column.
2336 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2336 def get_highlight_guide; end |
#get_hotspot_active_background ⇒ Wx::Colour Also known as: hotspot_active_background
Get the back colour for active hotspots.
1726 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1726 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.
1715 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1715 def get_hotspot_active_foreground; end |
#get_hotspot_active_underline ⇒ Boolean Also known as: hotspot_active_underline
Get whether underlining for active hotspots.
1737 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1737 def get_hotspot_active_underline; end |
#get_hotspot_single_line ⇒ Boolean Also known as: hotspot_single_line
Get the HotspotSingleLine property.
1748 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1748 def get_hotspot_single_line; end |
#get_identifier ⇒ Integer Also known as: identifier
Get the identifier.
3856 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3856 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.
1424 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1424 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.
2108 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2108 def get_ime_interaction; end |
#get_indent ⇒ Integer Also known as: indent
Retrieve indentation size.
2279 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2279 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.
2323 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2323 def get_indentation_guides; end |
#get_indicator_current ⇒ Integer Also known as: indicator_current
Get the current indicator.
2557 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2557 def get_indicator_current; end |
#get_indicator_value ⇒ Integer Also known as: indicator_value
Get the current indicator value.
2568 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2568 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
4061 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4061 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.
3365 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3365 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.
3942 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3942 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.
4066 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4066 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.
3582 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3582 def get_layout_cache; end |
#get_length ⇒ Integer Also known as: length
Returns the number of bytes in the document.
460 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 460 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.
3693 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3693 def get_lexer; end |
#get_lexer_language ⇒ String Also known as: lexer_language
Retrieve the lexing language of the document.
3746 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3746 def get_lexer_language; end |
#get_line(line) ⇒ String Also known as: line
Retrieve the contents of a line.
161 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 161 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.
569 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 569 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.
528 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 528 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.
1309 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1309 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.
1301 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1301 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.
1316 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1316 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.
2308 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2308 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.
2302 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2302 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.
4111 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4111 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).
685 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 685 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).
679 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 679 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.
1404 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1404 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.
4118 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4118 def get_line_text(lineNo) end |
#get_line_visible(line) ⇒ Boolean Also known as: line_visible
Is a line visible?
3389 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3389 def get_line_visible(line) end |
#get_main_selection ⇒ Integer Also known as: main_selection
Which selection is the main selection.
821 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 821 def get_main_selection; end |
#get_margin_background(margin) ⇒ Wx::Colour Also known as: margin_background
Retrieve the background colour of a margin.
1914 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1914 def get_margin_background(margin) end |
#get_margin_count ⇒ Integer Also known as: margin_count
How many margins are there?.
1925 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1925 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.
1900 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1900 def get_margin_cursor(margin) end |
#get_margin_left ⇒ Integer Also known as: margin_left
Returns the size in pixels of the left margin.
1936 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1936 def get_margin_left; end |
#get_margin_mask(margin) ⇒ Integer Also known as: margin_mask
Retrieve the marker mask of a margin.
1872 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1872 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.
2020 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2020 def ; end |
#get_margin_right ⇒ Integer Also known as: margin_right
Returns the size in pixels of the right margin.
1947 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1947 def get_margin_right; end |
#get_margin_sensitive(margin) ⇒ Boolean Also known as: margin_sensitive
Retrieve the mouse click sensitivity of a margin.
1884 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1884 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.
1848 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1848 def get_margin_type(margin) end |
#get_margin_width(margin) ⇒ Integer Also known as: margin_width
Retrieve the width of a margin in pixels.
1860 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1860 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.
2457 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2457 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.
1409 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1409 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.
3845 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3845 def get_mod_event_mask; end |
#get_modify ⇒ Boolean Also known as: modify
Is the document different from when it was last saved?
574 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 574 def get_modify; end |
#get_mouse_down_captures ⇒ Boolean Also known as: mouse_down_captures
Get whether mouse gets captured.
1245 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1245 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.
3830 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3830 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.
718 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 718 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.
1256 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1256 def get_mouse_wheel_captures; 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.
741 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 741 def get_multi_paste; end |
#get_multiple_selection ⇒ Boolean Also known as: multiple_selection
Whether multiple selections can be made.
752 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 752 def get_multiple_selection; 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.
2268 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2268 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.
Note that even empty text controls have one line (where the insertion point is), so #get_number_of_lines never returns 0.
4131 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4131 def get_number_of_lines; end |
#get_overtype ⇒ Boolean Also known as: overtype
Returns true if overtype mode is active otherwise false is returned.
339 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 339 def get_overtype; end |
#get_paste_convert_endings ⇒ Boolean Also known as: paste_convert_endings
Get convert-on-paste setting.
385 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 385 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.
2149 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2149 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?
3602 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3602 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.
3796 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3796 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.
3305 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3305 def get_print_colour_mode; end |
#get_print_magnification ⇒ Integer Also known as: print_magnification
Returns the print magnification.
3290 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3290 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.
3329 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3329 def get_print_wrap_mode; end |
#get_property(key) ⇒ String Also known as: property
Retrieve a “property” value previously set with SetProperty.
3728 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3728 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.
3734 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3734 def (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.
3741 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3741 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.
1372 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1372 def get_punctuation_chars; end |
#get_read_only ⇒ Boolean Also known as: read_only
In read-only mode?
155 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 155 def get_read_only; end |
#get_rectangular_selection_anchor ⇒ Integer Also known as: rectangular_selection_anchor
Return the anchor position of the rectangular selection.
915 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 915 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.
937 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 937 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.
904 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 904 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.
926 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 926 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.
967 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 967 def get_rectangular_selection_modifier; end |
#get_representation(encodedCharacter) ⇒ String Also known as: representation
Set the way a character is drawn.
1827 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1827 def get_representation(encodedCharacter) end |
#get_scroll_width ⇒ Integer Also known as: scroll_width
Retrieve the document width assumed for scrolling.
1070 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1070 def get_scroll_width; end |
#get_scroll_width_tracking ⇒ Boolean Also known as: scroll_width_tracking
Retrieve whether the scroll width tracks wide lines.
1081 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1081 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.
302 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 302 def get_search_flags; end |
#get_sel_alpha ⇒ Integer Also known as: sel_alpha
Get the alpha of the selection.
1630 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1630 def get_sel_alpha; end |
#get_sel_eol_filled ⇒ Boolean Also known as: sel_eol_filled
Is the selection end of line filled?
1641 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1641 def get_sel_eol_filled; end |
#get_selected_text ⇒ String Also known as: selected_text
Retrieve the selected text.
579 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 579 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.
4087 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4087 def get_selection; end |
#get_selection_empty ⇒ Boolean Also known as: selection_empty
Is every selected range empty?
795 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 795 def get_selection_empty; end |
#get_selection_end ⇒ Integer Also known as: selection_end
Returns the position at the end of the selection.
556 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 556 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.
673 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 673 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.
845 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 845 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.
869 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 869 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.
833 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 833 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.
857 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 857 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.
893 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 893 def get_selection_n_end(selection) end |
#get_selection_n_start(selection) ⇒ Integer Also known as: selection_n_start
Returns the position at the start of the selection.
881 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 881 def get_selection_n_start(selection) end |
#get_selection_start ⇒ Integer Also known as: selection_start
Returns the position at the start of the selection.
545 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 545 def get_selection_start; end |
#get_selections ⇒ Integer Also known as: selections
How many selections are there?
790 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 790 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.
404 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 404 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.
1234 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1234 def get_stc_cursor; end |
#get_stc_focus ⇒ Boolean Also known as: stc_focus
Get internal focus flag.
2189 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2189 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.
4164 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4164 def get_style(position, style) end |
#get_style_at(pos) ⇒ Integer Also known as: style_at
Returns the style byte at the position.
146 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 146 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.
3790 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3790 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.
3815 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3815 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.
3784 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3784 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.
3778 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3778 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.
1168 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1168 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?
2347 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2347 def get_tab_indents; end |
#get_tab_width ⇒ Integer Also known as: tab_width
Retrieve the visible size of a tab.
2250 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2250 def get_tab_width; end |
#get_tag(tagNumber) ⇒ String Also known as: tag
Retrieve the value of a tag from a regular expression search.
308 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 308 def get_tag(tagNumber) end |
#get_target_end ⇒ Integer Also known as: target_end
Get the position that ends the target.
247 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 247 def get_target_end; end |
#get_target_start ⇒ Integer Also known as: target_start
Get the position that starts the target.
236 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 236 def get_target_start; end |
#get_target_text ⇒ String Also known as: target_text
Retrieve the text in the target.
258 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 258 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.
2208 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2208 def get_technology; end |
#get_text ⇒ String Also known as: text
Retrieve all the text in the document.
190 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 190 def get_text; end |
#get_text_length ⇒ Integer Also known as: text_length
Retrieve the number of characters in the document.
604 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 604 def get_text_length; end |
#get_text_range(startPos, endPos) ⇒ String Also known as: text_range
Retrieve a range of text.
168 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 168 def get_text_range(startPos, endPos) end |
#get_two_phase_draw ⇒ Boolean Also known as: two_phase_draw
Is drawing done in two phases with backgrounds drawn before foregrounds?
2134 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2134 def get_two_phase_draw; end |
#get_undo_collection ⇒ Boolean Also known as: undo_collection
Is undo history being collected?
424 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 424 def get_undo_collection; end |
#get_use_anti_aliasing ⇒ Boolean Also known as: use_anti_aliasing
Returns the current UseAntiAliasing setting.
3996 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3996 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?
1036 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1036 def ; end |
#get_use_tabs ⇒ Boolean Also known as: use_tabs
Retrieve whether tabs will be used in indentation.
2290 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2290 def get_use_tabs; end |
#get_use_vertical_scroll_bar ⇒ Boolean Also known as: use_vertical_scroll_bar
Is the vertical scroll bar visible?
1105 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1105 def ; end |
#get_view_eol ⇒ Boolean Also known as: view_eol
Are the end of line characters visible?
1279 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1279 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.
1153 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1153 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.
952 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 952 def ; 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.
1361 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1361 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.
1199 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1199 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.
1329 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1329 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.
3575 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3575 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.
3517 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3517 def get_wrap_mode; end |
#get_wrap_start_indent ⇒ Integer Also known as: wrap_start_indent
Retrieve the start indent for wrapped lines.
3558 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3558 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.
3532 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3532 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.
3547 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3547 def get_wrap_visual_flags_location; end |
#get_x_offset ⇒ Integer Also known as: x_offset
Get the xOffset (ie, horizontal scroll position).
1130 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1130 def get_x_offset; end |
#get_zoom ⇒ Integer Also known as: zoom
Retrieve the zoom level.
3623 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3623 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.
491 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 491 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.
496 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 496 def goto_pos(caret) end |
#hide_lines(lineStart, lineEnd) ⇒ void
This method returns an undefined value.
Make a range of lines invisible.
3384 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3384 def hide_lines(lineStart, lineEnd) end |
#hide_selection(hide) ⇒ void
This method returns an undefined value.
Draw the selection in normal style or with selection highlighted.
585 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 585 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.
4202 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4202 def hit_test(pt) end |
#home ⇒ void
This method returns an undefined value.
Move caret to first position on line.
2923 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2923 def home; end |
#home_display ⇒ void
This method returns an undefined value.
Move caret to first position on display line.
3061 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3061 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.
3065 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3065 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.
2927 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2927 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.
3161 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3161 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.
3077 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3077 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.
3081 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3081 def home_wrap_extend; end |
#indicator_all_on_for(pos) ⇒ Integer
Are any indicators present at pos?
2586 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2586 def indicator_all_on_for(pos) end |
#indicator_clear_range(start, lengthClear) ⇒ void
This method returns an undefined value.
Turn an indicator off over a range.
2581 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2581 def indicator_clear_range(start, lengthClear) end |
#indicator_end(indicator, pos) ⇒ Integer
Where does a particular indicator end?
2604 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2604 def indicator_end(indicator, pos) end |
#indicator_fill_range(start, lengthFill) ⇒ void
This method returns an undefined value.
Turn an indicator on over a range.
2575 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2575 def indicator_fill_range(start, lengthFill) end |
#indicator_get_alpha(indicator) ⇒ Integer
Get the alpha fill colour of the given indicator.
2615 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2615 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.
2547 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2547 def indicator_get_flags(indicator) end |
#indicator_get_foreground(indicator) ⇒ Wx::Colour
Retrieve the foreground colour of an indicator.
2499 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2499 def indicator_get_foreground(indicator) end |
#indicator_get_hover_foreground(indicator) ⇒ Wx::Colour
Retrieve the foreground hover colour of an indicator.
2532 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2532 def indicator_get_hover_foreground(indicator) end |
#indicator_get_hover_style(indicator) ⇒ Integer
Retrieve the hover style of an indicator.
2521 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2521 def indicator_get_hover_style(indicator) end |
#indicator_get_outline_alpha(indicator) ⇒ Integer
Get the alpha outline colour of the given indicator.
2626 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2626 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.
2488 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2488 def indicator_get_style(indicator) end |
#indicator_get_under(indicator) ⇒ Boolean
Retrieve whether indicator drawn under or over text.
2510 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2510 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.
2610 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2610 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.
2540 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2540 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.
2494 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2494 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.
2527 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2527 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.
2516 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2516 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.
2621 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2621 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.
2481 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2481 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).
2505 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2505 def indicator_set_under(indicator, under) end |
#indicator_start(indicator, pos) ⇒ Integer
Where does a particular indicator start?
2598 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2598 def indicator_start(indicator, pos) end |
#indicator_value_at(indicator, pos) ⇒ Integer
What value does a particular indicator have at a position?
2592 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2592 def indicator_value_at(indicator, pos) end |
#insert_text(pos, text) ⇒ void
This method returns an undefined value.
Insert string at a position.
115 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 115 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.
4094 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4094 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.
4139 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4139 def is_modified; end |
#is_range_word(start, end_) ⇒ Boolean Also known as: range_word?
Is the range start..end considered a word?
1348 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1348 def is_range_word(start, end_) end |
#line_copy ⇒ void
This method returns an undefined value.
Copy the line containing the caret.
3101 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3101 def line_copy; end |
#line_cut ⇒ void
This method returns an undefined value.
Cut the line containing the caret.
3023 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3023 def line_cut; end |
#line_delete ⇒ void
This method returns an undefined value.
Delete the line containing the caret.
3027 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3027 def line_delete; end |
#line_down ⇒ void
This method returns an undefined value.
Move caret down one line.
2875 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2875 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.
2879 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2879 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.
3145 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3145 def line_down_rect_extend; end |
#line_duplicate ⇒ void
This method returns an undefined value.
Duplicate the current line.
3035 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3035 def line_duplicate; end |
#line_end ⇒ void
This method returns an undefined value.
Move caret to last position on line.
2931 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2931 def line_end; end |
#line_end_display ⇒ void
This method returns an undefined value.
Move caret to last position on display line.
3069 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3069 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.
3073 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3073 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.
2935 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2935 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.
3171 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3171 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.
3085 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3085 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.
3089 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3089 def line_end_wrap_extend; end |
#line_from_position(pos) ⇒ Integer
Retrieve the line containing a position.
595 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 595 def line_from_position(pos) end |
#line_length(line) ⇒ Integer
How many characters are on a line, including end of line characters?
627 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 627 def line_length(line) end |
#line_scroll(columns, lines) ⇒ void
This method returns an undefined value.
Scroll horizontally and vertically.
1048 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1048 def line_scroll(columns, lines) end |
#line_scroll_down ⇒ void
This method returns an undefined value.
Scroll the document down, keeping the caret visible.
3047 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3047 def line_scroll_down; end |
#line_scroll_up ⇒ void
This method returns an undefined value.
Scroll the document up, keeping the caret visible.
3051 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3051 def line_scroll_up; end |
#line_transpose ⇒ void
This method returns an undefined value.
Switch the current line with the previous.
3031 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3031 def line_transpose; end |
#line_up ⇒ void
This method returns an undefined value.
Move caret up one line.
2883 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2883 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.
2887 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2887 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.
3149 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3149 def line_up_rect_extend; end |
#lines_join ⇒ void
This method returns an undefined value.
Join the lines in the target.
3587 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3587 def lines_join; end |
#lines_on_screen ⇒ Integer
Retrieves the number of lines completely visible.
631 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 631 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.
3592 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3592 def lines_split(pixelWidth) end |
#load_file(filename) ⇒ Boolean
Load the contents of filename into the editor.
3959 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3959 def load_file(filename) end |
#load_lexer_library(path) ⇒ void
This method returns an undefined value.
Load a lexer library (dll / so).
3723 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3723 def load_lexer_library(path) end |
#lower_case ⇒ void
This method returns an undefined value.
Transform the selection to lower case.
3039 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3039 def lower_case; end |
#margin_get_style(line) ⇒ Integer
Get the style number for the text margin for a line.
1982 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1982 def margin_get_style(line) end |
#margin_get_style_offset ⇒ Integer
Get the start of the range of style numbers used for margin text.
2006 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2006 def margin_get_style_offset; end |
#margin_get_styles(line) ⇒ String
Get the styles in the text margin for a line.
1993 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1993 def margin_get_styles(line) end |
#margin_get_text(line) ⇒ String
Get the text in the text margin for a line.
1971 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1971 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.
1977 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1977 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.
2002 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2002 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.
1988 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1988 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.
1966 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1966 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.
1997 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1997 def margin_text_clear_all; end |
#mark_dirty ⇒ void
This method returns an undefined value.
Mark text as modified (dirty).
4147 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4147 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.
2408 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2408 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.
2444 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2444 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.
2379 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2379 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.
4008 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4008 def marker_define_bitmap(markerNumber, bmp) end |
#marker_delete(line, markerNumber) ⇒ void
This method returns an undefined value.
Delete a marker from a line.
2414 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2414 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.
2419 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2419 def marker_delete_all(markerNumber) end |
#marker_delete_handle(markerHandle) ⇒ void
This method returns an undefined value.
Delete a marker.
2369 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2369 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)
2402 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2402 def marker_enable_highlight(enabled) end |
#marker_get(line) ⇒ Integer
Get a bit mask of all the markers set on a line.
2424 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2424 def marker_get(line) end |
#marker_line_from_handle(markerHandle) ⇒ Integer
Retrieve the line number at which a particular marker is located.
2364 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2364 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.
2432 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2432 def marker_next(lineStart, markerMask) end |
#marker_previous(lineStart, markerMask) ⇒ Integer
Find the previous line before lineStart that includes a marker in mask.
2438 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2438 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.
2450 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2450 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.
2391 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2391 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.
2397 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2397 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.
2385 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2385 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.
622 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 622 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.
727 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 727 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.
723 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 723 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.
3669 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3669 def multi_edge_add_line(column, edgeColour) end |
#multi_edge_clear_all ⇒ void
This method returns an undefined value.
Clear all vertical edges.
3673 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3673 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.
1026 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1026 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.
1020 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1020 def multiple_select_add_next; 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.
2993 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2993 def new_line; end |
#page_down ⇒ void
This method returns an undefined value.
Move caret one page down.
2963 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2963 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.
2967 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2967 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.
3179 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3179 def page_down_rect_extend; end |
#page_up ⇒ void
This method returns an undefined value.
Move caret one page up.
2955 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2955 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.
2959 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2959 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.
3175 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3175 def page_up_rect_extend; end |
#para_down ⇒ void
This method returns an undefined value.
Move caret down one paragraph (delimited by empty lines).
3129 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3129 def para_down; end |
#para_down_extend ⇒ void
This method returns an undefined value.
Extend selection down one paragraph (delimited by empty lines).
3133 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3133 def para_down_extend; end |
#para_up ⇒ void
This method returns an undefined value.
Move caret up one paragraph (delimited by empty lines).
3137 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3137 def para_up; end |
#para_up_extend ⇒ void
This method returns an undefined value.
Extend selection up one paragraph (delimited by empty lines).
3141 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3141 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.
357 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 357 def paste; end |
#point_from_position(pos) ⇒ Wx::Point
Retrieve the point in the window where a position is displayed.
590 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 590 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.
653 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 653 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.
646 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 646 def position_before(pos) end |
#position_from_line(line) ⇒ Integer
Retrieve the position at the start of a line.
600 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 600 def position_from_line(line) end |
#position_from_point(pt) ⇒ Integer
Find the position from a point within the window.
480 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 480 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.
486 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 486 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.
661 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 661 def position_relative(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).
4187 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4187 def position_to_xy(pos) end |
#property_names ⇒ String
Retrieve a ‘n’ separated list of properties understood by the current lexer.
3751 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3751 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.
3758 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3758 def property_type(name) end |
#redo_ ⇒ void
This method returns an undefined value.
Redoes the next action on the undo history.
409 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 409 def redo_; end |
#register_image(type, bmp) ⇒ void
This method returns an undefined value.
Register an image for use in autocompletion lists.
2727 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2727 def register_image(type, bmp) end |
#release_all_extended_styles ⇒ void
This method returns an undefined value.
Release all extended (>255) style numbers.
205 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 205 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.
4027 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4027 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.
4036 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4036 def replace(from, to, value) end |
#replace_selection(text) ⇒ void
This method returns an undefined value.
Replace the selected text with the argument text.
174 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 174 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.
274 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 274 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.
281 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 281 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.
2468 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2468 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.
2473 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2473 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.
2463 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2463 def rgba_image_set_width(width) end |
#rotate_selection ⇒ void
This method returns an undefined value.
Set the main selection to the next selection.
1010 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1010 def rotate_selection; end |
#save_file(filename) ⇒ Boolean
Write the contents of the editor to filename.
3954 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3954 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.
1060 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1060 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.
3919 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3919 def scroll_to_column(column) end |
#scroll_to_end ⇒ void
This method returns an undefined value.
Scroll to end of document.
3229 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3229 def scroll_to_end; end |
#scroll_to_line(line) ⇒ void
This method returns an undefined value.
Scroll enough to make the given line visible.
3914 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3914 def scroll_to_line(line) end |
#scroll_to_start ⇒ void
This method returns an undefined value.
Scroll to start of document.
3225 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3225 def scroll_to_start; end |
#search_anchor ⇒ void
This method returns an undefined value.
Sets the current caret position to be the search anchor.
313 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 313 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 length of range or -1 for failure in which case target is not moved.
288 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 288 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.
321 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 321 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.
329 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 329 def search_prev(searchFlags, text) end |
#select_all ⇒ void
This method returns an undefined value.
Select all the text in the document.
475 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 475 def select_all; end |
#select_none ⇒ void
This method returns an undefined value.
Deselects selected text in the control.
4081 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4081 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.
3217 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3217 def selection_duplicate; end |
#selection_is_rectangle ⇒ Boolean
Is the selection rectangular? The alternative is the more common stream selection.
635 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 635 def selection_is_rectangle; end |
#send_msg(msg, wp = 0, lp = 0) ⇒ Integer
Scintilla API call.
3926 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3926 def send_msg(msg, wp=0, lp=0) 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.
1000 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1000 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.
769 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 769 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.
780 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 780 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.
989 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 989 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.
983 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 983 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.
975 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 975 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.
758 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 758 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.
503 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 503 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.
3468 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3468 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.
2353 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2353 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.
2095 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2095 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.
1653 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1653 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.
1773 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1773 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.
1688 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1688 def set_caret_line_background(back) 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.
1677 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1677 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.
1804 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1804 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.
1666 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1666 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.
1763 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1763 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.
1786 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1786 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.
1699 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1699 def set_caret_width(pixelWidth) end |
#set_chars_default ⇒ void
This method returns an undefined value.
Reset the set of characters for whitespace and word characters to the defaults.
1377 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1377 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.
2101 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2101 def set_code_page(codePage) 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.
1810 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1810 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.
534 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 534 def set_current_pos(caret) 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.
4170 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4170 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.
3662 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3662 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.
3636 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3636 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.
3651 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3651 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.
4103 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4103 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.
562 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 562 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.
1089 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1089 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.
1274 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1274 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.
1205 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1205 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.
1216 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1216 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.
1111 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1111 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.
3401 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3401 def (line, ) 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.
3483 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3483 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.
3353 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3353 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.
1954 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1954 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.
1960 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1960 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>
2171 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2171 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.
3937 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3937 def () 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.
2331 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2331 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.
1722 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1722 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.
1711 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1711 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.
1732 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1732 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.
1743 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1743 def set_hotspot_single_line(singleLine) end |
#set_identifier(identifier) ⇒ void Also known as: identifier=
This method returns an undefined value.
Set the identifier reported as idFrom in notification messages.
3851 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3851 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.
3807 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3807 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.
1417 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1417 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 winow or inline.
The input should be one of the wxSTC_IME_* constants.
2116 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2116 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.
2274 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2274 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.
2316 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2316 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.
2552 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2552 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.
2563 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2563 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.
4041 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4041 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.
3712 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3712 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.
3948 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3948 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.
2129 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2129 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.
3686 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3686 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.
3717 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3717 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.
1294 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1294 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.
2297 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2297 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.
1399 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1399 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.
816 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 816 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.
1909 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1909 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.
1920 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1920 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.
1893 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1893 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.
1931 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1931 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.
1867 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1867 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.
2013 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2013 def (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.
1942 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1942 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.
1879 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1879 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.
1841 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1841 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.
1855 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1855 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.
3909 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3909 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.
3838 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3838 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.
1240 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1240 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.
3823 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3823 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.
713 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 713 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.
1251 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1251 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.
734 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 734 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.
747 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 747 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.
334 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 334 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.
380 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 380 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.
2158 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2158 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.
3597 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3597 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.
3298 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3298 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.
3285 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3285 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).
3322 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3322 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.
3706 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3706 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.
1367 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1367 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.
179 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 179 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.
910 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 910 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.
932 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 932 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.
899 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 899 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.
921 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 921 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.
960 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 960 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.
1822 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1822 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.
151 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 151 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.
1065 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1065 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.
1076 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1076 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.
295 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 295 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.
1636 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1636 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.
1626 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1626 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.
1647 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1647 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.
1620 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1620 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.
4077 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4077 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.
551 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 551 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).
666 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 666 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.
840 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 840 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.
864 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 864 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.
828 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 828 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.
852 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 852 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.
888 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 888 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.
876 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 876 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.
540 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 540 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.
397 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 397 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.
1227 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1227 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.
2184 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2184 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.
4158 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4158 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.
1393 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1393 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.
1176 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1176 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.
2342 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2342 def set_tab_indents(tabIndents) 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.
2245 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2245 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.
242 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 242 def set_target_end(end_) 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.
254 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 254 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.
231 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 231 def set_target_start(start) end |
#set_technology(technology) ⇒ void Also known as: technology=
This method returns an undefined value.
Set the technology used.
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.
2201 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2201 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.
185 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 185 def set_text(text) end |
#set_two_phase_draw(twoPhase) ⇒ void Also known as: two_phase_draw=
This method returns an undefined value.
In twoPhaseDraw mode, drawing is performed in two phases, first the background and then the foreground.
This avoids chopping off characters that overlap the next run.
2142 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2142 def set_two_phase_draw(twoPhase) 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.
414 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 414 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.
3991 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3991 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.
1031 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1031 def (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.
2285 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2285 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.
1100 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1100 def (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.
3931 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3931 def () 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.
1285 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1285 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.
1161 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1161 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.
945 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 945 def (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.
1120 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1120 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.
1189 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1189 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.
1356 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1356 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.
1183 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1183 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.
1194 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1194 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.
1324 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1324 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.
3567 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3567 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.
3510 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3510 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.
3553 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3553 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.
3525 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3525 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.
3540 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3540 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.
1140 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1140 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).
1125 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1125 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.
1149 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1149 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.
3618 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3618 def set_zoom(zoomInPoints) end |
#show_lines(lineStart, lineEnd) ⇒ void
This method returns an undefined value.
Make a range of lines visible.
3378 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3378 def show_lines(lineStart, lineEnd) end |
#show_position(pos) ⇒ void
This method returns an undefined value.
Makes the line containing the given position visible.
4192 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4192 def show_position(pos) end |
#start_record ⇒ void
This method returns an undefined value.
Start notifying the container of all key presses and commands.
3276 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3276 def start_record; end |
#start_styling(start) ⇒ void
This method returns an undefined value.
Set the current styling position to start.
1387 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1387 def start_styling(start) end |
#stop_record ⇒ void
This method returns an undefined value.
Stop notifying the container of all key presses and commands.
3280 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3280 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.
3191 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3191 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.
3195 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3195 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.
3183 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3183 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.
3187 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3187 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.
1429 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1429 def style_clear_all; end |
#style_get_background(style) ⇒ Wx::Colour
Get the background colour of a style.
1491 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1491 def style_get_background(style) end |
#style_get_bold(style) ⇒ Boolean
Get is a style bold or not.
1496 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1496 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.
1528 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1528 def style_get_case(style) end |
#style_get_changeable(style) ⇒ Boolean
Get is a style changeable or not (read only).
Experimental feature, currently buggy.
1545 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1545 def style_get_changeable(style) end |
#style_get_character_set(style) ⇒ Integer
Get the character get of the font in a style.
1533 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1533 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.
1516 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1516 def style_get_eol_filled(style) end |
#style_get_face_name(style) ⇒ String
Get the font facename of a style.
1511 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1511 def style_get_face_name(style) end |
#style_get_font(style) ⇒ Wx::Font
Get the font of a style.
3875 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3875 def style_get_font(style) end |
#style_get_foreground(style) ⇒ Wx::Colour
Get the foreground colour of a style.
1486 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1486 def style_get_foreground(style) end |
#style_get_hot_spot(style) ⇒ Boolean
Get is a style a hotspot or not.
1550 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1550 def style_get_hot_spot(style) end |
#style_get_italic(style) ⇒ Boolean
Get is a style italic or not.
1501 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1501 def style_get_italic(style) end |
#style_get_size(style) ⇒ Integer
Get the size of characters of a style.
1506 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1506 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.
1571 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1571 def style_get_size_fractional(style) end |
#style_get_underline(style) ⇒ Boolean
Get is a style underlined or not.
1521 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1521 def style_get_underline(style) end |
#style_get_visible(style) ⇒ Boolean
Get is a style visible or not.
1538 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1538 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.
1586 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1586 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.
1475 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1475 def style_reset_default; end |
#style_set_background(style, back) ⇒ void
This method returns an undefined value.
Set the background colour of a style.
1441 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1441 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.
1447 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1447 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.
1558 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1558 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.
1614 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1614 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.
1594 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1594 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.
1471 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1471 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.
1465 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1465 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.
3881 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3881 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.
3892 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3892 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.
3898 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3898 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.
1435 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1435 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.
1600 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1600 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.
1453 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1453 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.
1459 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1459 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.
1566 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1566 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
3870 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3870 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.
1481 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1481 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.
1606 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1606 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.
1579 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1579 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.
1014 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1014 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.
2985 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2985 def tab; 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.
263 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 263 def target_from_selection; end |
#target_whole_document ⇒ void
This method returns an undefined value.
Sets the target to the whole document.
267 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 267 def target_whole_document; end |
#text_height(line) ⇒ Integer
Retrieve the height of a particular line of text in pixels.
618 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 618 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.
613 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 613 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.
1768 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1768 def toggle_caret_sticky; end |
#toggle_fold(line) ⇒ void
This method returns an undefined value.
Switch a header line between expanded and contracted.
3412 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3412 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.
3418 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3418 def toggle_fold_show_text(line, text) end |
#undo ⇒ void
This method returns an undefined value.
Undo one action in the undo history.
448 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 448 def undo; end |
#upper_case ⇒ void
This method returns an undefined value.
Transform the selection to upper case.
3043 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3043 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>
3272 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3272 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.
2817 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2817 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.
3003 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3003 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.
3235 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3235 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.
3239 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3239 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.
3007 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3007 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.
3167 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3167 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.
3093 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3093 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.
3097 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3097 def vc_home_wrap_extend; end |
#vertical_centre_caret ⇒ void
This method returns an undefined value.
Centre current line in window.
3221 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3221 def vertical_centre_caret; end |
#visible_from_doc_line(docLine) ⇒ Integer
Find the display line of a document line taking hidden lines into account.
3340 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3340 def visible_from_doc_line(docLine) end |
#word_end_position(pos, onlyWordCharacters) ⇒ Integer
Get position of end of word.
1342 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1342 def word_end_position(pos, onlyWordCharacters) end |
#word_left ⇒ void
This method returns an undefined value.
Move caret left one word.
2907 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2907 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.
3199 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3199 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.
3203 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3203 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.
2911 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2911 def word_left_extend; end |
#word_part_left ⇒ void
This method returns an undefined value.
Move to the previous change in capitalisation.
3105 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3105 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.
3109 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3109 def word_part_left_extend; end |
#word_part_right ⇒ void
This method returns an undefined value.
Move to the change next in capitalisation.
3113 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3113 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.
3117 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3117 def word_part_right_extend; end |
#word_right ⇒ void
This method returns an undefined value.
Move caret right one word.
2915 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2915 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.
3207 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3207 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.
3211 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3211 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.
2919 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 2919 def word_right_extend; end |
#word_start_position(pos, onlyWordCharacters) ⇒ Integer
Get position of start of word.
1336 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 1336 def word_start_position(pos, onlyWordCharacters) end |
#wrap_count(docLine) ⇒ Integer
The number of display lines needed to wrap a document line.
3503 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3503 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.
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.
4019 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4019 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.
4179 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 4179 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.
3607 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3607 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.
3611 |
# File 'lib/wx/doc/gen/stc/styled_text_ctrl.rb', line 3611 def zoom_out; end |