Wx::StyledTextCtrl is a sophisticated text editing control. It is
based on the open-source Scintilla component,
wrapped to form part of the wxWidgets and wxRuby APIs.
It is particularly suited for editing source code of a variety of
programming languages. It has built-in support in the form of
Lexers for many common languages,
including Ruby, Python, HTML, C/C++ and SQL. As well as customisable
syntax highlighting, it also supports
code-folding, autocompletion and indentation.
However, its use is not restricted to source-code editing. It has a wide
set of features for text navigation, editing, viewing and printing. For
complex uses, it can be a useful alternative to using
TextCtrl with the TE_RICH
flag; it has a richer set of
features, which are implemented more consistently across platforms than
the native-based control.
The methods listed here are a complete listing of all the methods
supported by StyledTextCtrl in wxRuby. However, at present only a stub
description of each method is available. For much more thorough
discussion of the capabilities of StyledTextCtrl, please consult the
Scintilla documentation
.
Many methods listed as accepting Integer
require a specific flag; for
example, Markers are selected by a set of
special constants. At the moment, the names can be got from the
Scintilla documentation. They then need to be converted to wxRuby
constant names by changing the prefix from SC_
(Scintilla) to STC_
(StyledTextCtrl)
A StyledTextCtrl has a number of event handlers, each of which will be
passed a StyledTextEvent
evt_stc_calltip_click(id) { | event | … } | A calltip was clicked |
evt_stc_change(id) { | event | … } | The text contents was changed |
evt_stc_charadded(id) { | event | … } | A character was added |
evt_stc_doubleclick(id) { | event | … } | Double-click on the control |
evt_stc_do_drop(id) { | event | … } | Drag and drop ended on the control |
evt_stc_drag_over(id) { | event | … } | The cursor was moved over the control while dragging |
evt_stc_dwellend(id) { | event | … } | THe mouse ceased to dwell over a point |
evt_stc_dwellstart(id) { | event | … } | The cursor was dwelling over a point for the user-defined dwell period |
evt_stc_hotspot_click(id) { | event | … } | A hotspot was clicked |
evt_stc_hotspot_dclick(id) { | event | … } | A hotspot was double-clicked |
evt_stc_key(id) { | event | … } | A command key was pressed |
evt_stc_macrorecord(id) { | event | … } | A recordable action took place while macro recording |
evt_stc_marginclick(id) { | event | … } | A margin was clicked |
evt_stc_modified(id) { | event | … } | The contents was modified |
evt_stc_savepointleft(id) { | event | … } | The control was changed from it’s last-saved state |
evt_stc_savepointreached(id) { | event | … } | The last-saved state was reached in an undo/redo chain |
evt_stc_start_drag(id) { | event | … } | Dragging started in the control |
evt_stc_styleneeded(id) { | event | … } | A language lexer requested a style |
evt_stc_updateui(id) { | event | … } | An update UI event |
evt_stc_uridropped(id) { | event | … } | A URL was dropped in the control started in the control |
evt_stc_userlistselection(id) { | event | … } | An user-defined auto-completion entry was chosen |
evt_stc_zoom(id) { | event | … } | The control view was zoomed by keyboard or set_zoom |
Since StyledTextCtrl supports so many methods, they are broken down here
into groups.
Add text to the document at current position.
Enlarge the document to a particular size of text bytes.
Append a string to the end of the document without changing the selection.
Delete all text in the document.
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.
Returns the character byte at the position.
Returns the number of characters in the document.
Retrieve the contents of a line.
Returns the number of lines in the document. There is always at least one.
Is the document different from when it was last saved?
Returns true if overtype mode is active otherwise false is returned.
In read-only mode?
Retrieve all the text in the document.
Retrieve the number of characters in the document.
Retrieve a range of text.
Insert string at a position.
How many characters are on a line, not including end of line characters?
Given a valid document position, return the next position taking code page into account. Maximum value returned is the last position in the document.
Given a valid document position, return the previous position taking code page into account. Returns 0 if passed 0.
Send a message to Scintilla
Set to overtype (true) or insert mode.
Set to read only or read write.
Replace the contents of the document with the argument text.
Get the code page used to interpret the bytes of the document as characters.
Set the code page used to interpret the bytes of the document as characters.
Convert all line endings in the document to one mode.
Retrieve the current end of line mode – one of CRLF, CR, or LF.
Are the end of line characters visible?
Set the current end of line mode.
Make the end of line characters visible or invisible.
Retrieve the column number of a position, taking tab width into account.
#else
Retrieve the display line at the top of the display.
Get the position after the last visible characters on a line.
Retrieve the line containing a position.
#endif Retrieve the point in the window where a position is displayed. wxPo
Retrieve the position at the start of a line.
Find the position from a point within the window.
Find the position from a point within the window but return INVALID_POSITION if not close to text.
Set caret to start of a line and ensure it is visible.
Set caret to a position and ensure it is visible.
Move caret down one line.
Scroll enough to make the given column visible
Scroll enough to make the given line visible
Returns the position of the opposite end of the selection to the caret.
Returns the line number of the line with the caret.
Returns the position of the caret.
Retrieve the position of the end of the selection at the given line (INVALID_POSITION if no selection on this line).
Retrieve the position of the start of the selection at the given line (INVALID_POSITION if no selection on this line).
Get the alpha of the selection.
Retrieve the selected text.
#else
Returns the position at the end of the selection.
Get the mode of the current selection.
Returns the position at the start of the selection.
Get cursor type.
Draw the selection in normal style or with selection highlighted.
Replace the selected text with the argument text.
Select all the text in the document.
Is the selection rectangular? The alternative is the more common stream selection.
Set the selection anchor to a position. The anchor is the opposite end of the selection from the caret.
Sets the position of the caret.
Set the alpha of the selection.
Set the background colour of the selection and whether to use this setting.
Set the foreground colour of the selection and whether to use this setting.
Select a range of text.
Sets the position that ends the selection – this becomes the currentPosition.
Set the selection mode to stream (SC_SEL_STREAM) or rectangular (SC_SEL_RECTANGLE) or by lines (SC_SEL_LINES).
Sets the position that starts the selection – this becomes the anchor.
Sets the cursor to one of the SC_CURSOR* values.
Retrieve the degree of caching of layout information.
Retrieve whether text is word wrapped.
Retrive the start indent for wrapped lines.
Retrive the display mode of visual flags for wrapped lines.
Retrive the location of visual flags for wrapped lines.
Join the lines in the target.
Split the lines in the target into lines that are less wide than pixelWidth where possible.
Sets the degree of caching of layout information.
Sets whether text is word wrapped.
Set the start indent for wrapped lines.
Set the display mode of visual flags for wrapped lines.
Set the location of visual flags for wrapped lines.
Get position of end of word.
Get position of start of word.
The number of display lines needed to wrap a document line
Set the last x chosen value to be the caret x position.
Retrieve whether the maximum scroll position has the last line at the bottom of the view.
Retrieve the document width assumed for scrolling.
Is the horizontal scroll bar visible?
Is the vertical scroll bar visible?
Scroll horizontally and vertically.
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.
Set the horizontal scrollbar to use instead of the ont that’s built-in.
Sets the document width assumed for scrolling.
Show or hide the horizontal scroll bar.
Show or hide the vertical scroll bar.
Set the way the display area is determined when a particular line is to be moved to by Find, FindNext, GotoLine, etc.
Set the vertical scrollbar to use instead of the ont that’s built-in.
Set the way the caret is kept visible when going sideway. The exclusion zone is given in pixels.
Get and Set the xOffset (ie, horizonal scroll position).
Set the way the line the caret is on is kept visible. The exclusion zone is given in lines.
Retrieve the height of a particular line of text in pixels.
Measure the pixel width of some text in a particular style. NUL terminated text argument. Does not handle tab or control characters.
Will a paste succeed?
Clear the selection.
Copy the selection to the clipboard.
Copy a range of text to the clipboard. Positions are clipped into the document.
Copy argument text to the clipboard.
Cut the selection to the clipboard.
Get convert-on-paste setting
Paste the contents of the clipboard into the document replacing the selection.
Enable/Disable convert-on-paste for line endings
Start a sequence of actions that is undone and redone as a unit. May be nested.
Are there any redoable actions in the undo history?
Are there any undoable actions in the undo history?
Delete the undo history.
End a sequence of actions that is undone and redone as a unit.
Is undo history being collected?
Redoes the next action on the undo history.
Remember the current position in the undo history as the position at which the document was saved.
Choose between collecting actions into the undo history and discarding them.
Undo one action in the undo history.
Find some text in the document.
Get the search flags used by SearchInTarget.
Get the position that ends the target.
Get the position that starts the target.
Replace the target text with the argument text. Text is counted so it can contain NULs. Returns the length of the replacement text.
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.
Sets the current caret position to be the search anchor.
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.
Find some text starting at the search anchor. Does not ensure the selection is visible.
Find some text starting at the search anchor and moving backwards. Does not ensure the selection is visible.
Set the search flags used by SearchInTarget.
Sets the position that ends the target which is used for updating the document without affecting the scroll position.
Sets the position that starts the target which is used for updating the document without affecting the scroll position.
Make the target range start and end be the same as the selection range start and end.
Set all style bytes to 0, remove all folding information.
#endif Retrieve the position of the last correctly styled character.
Retrieve the extra styling information for a line.
Retrieve the last line number that has line state.
Returns the style byte at the position.
Retrieve number of bits in style bytes used to hold the lexical state.
Set a back colour for active hotspots.
Set a fore colour for active hotspots.
Enable / Disable underlining active hotspots.
Limit hotspots to single line so hotspots on two lines don’t merge.
Used to hold extra styling information for each line.
Divide each styling byte into lexical class bits (default: 5) and indicator bits (default: 3). If a lexer requires more than 32 lexical states, then this is used to expand the possible states.
Set the styles for a segment of the document.
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 the current styling position to pos and the styling mask to mask. The styling mask can be used to protect some bits in each styling byte from modification.
Clear all the styles and make equivalent to the global default style.
Reset the default style to its state at startup
Set the background colour of a style.
Set a style to be bold or not.
Set a style to be mixed case, or to force upper or lower case.
Set a style to be changeable or not (read only). Experimental feature, currently buggy.
Set the character set of the font in a style. Converts the Scintilla character set values to a wxFontEncoding.
Set a style to have its end of line filled or not.
Set the font of a style.
Set style size, face, bold, italic, and underline attributes from a wxFont’s attributes.
Set all font style attributes at once.
Set the font encoding to be used by a style.
Set the foreground colour of a style.
Set a style to be a hotspot or not.
Set a style to be italic or not.
Set the size of characters of a style.
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:[facename] sets the font face name to use size:[num] sets the font size in points eol turns on eol filling underline turns on underlining
Set a style to be underlined or not.
Set a style to be visible or not.
Retrieve the foreground colour of an indicator.
Retrieve the style of an indicator.
Set the foreground colour of an indicator.
Set an indicator to plain, squiggle or TT.
Colourise a segment of the document using the current lexing language.
Retrieve the lexing language of the document.
Retrieve a ‘property’ value previously set with SetProperty.
Retrieve a ‘property’ value previously set with SetProperty, with ‘$()’ variable replacement on returned buffer.
Retrieve a ‘property’ value previously set with SetProperty, interpreted as an int AFTER any ‘$()’ variable replacement.
Retrieve the number of bits the current lexer needs for styling.
Set up the key words used by the lexer.
Set the lexing language of the document.
Set the lexing language of the document based on string name.
Set up a value that may be used by a lexer for some optional feature.
Ensure the caret is visible.
Get the foreground colour of the caret.
Get the background alpha of the caret line.
Get the colour of the background of the line containing the caret.
Is the background of the line containing the caret in a different colour?
Get the time in milliseconds that the caret is on and off.
Can the caret preferred x position only be changed by explicit movement commands?
Returns the width of the insert mode caret.
Get the way control characters are displayed.
Move the caret inside current view if it’s not there already.
Set the foreground colour of the caret.
Set background alpha of the caret line.
Set the colour of the background of the line containing the caret.
Display the background of the line containing the caret in a different colour.
Get the time in milliseconds that the caret is on and off. 0 = steady on.
Stop the caret preferred x position changing when the user types.
Set the width of the insert mode caret.
Change the way control characters are displayed: If symbol is < 32, keep the drawn way, else, use the given character.
Switch between sticky and non-sticky: meant to be bound to a key.
Does a backspace pressed when caret is within indentation unindent?
Get the highlighted indentation guide column.
Retrieve indentation size.
Are the indentation guides visible?
Retrieve the position before the first non indentation character on a line.
Retrieve the number of columns that a line is indented.
Does a tab pressed when caret is within indentation indent?
Retrieve the visible size of a tab.
Retrieve whether tabs will be used in indentation.
Sets whether a backspace pressed when caret is within indentation unindents.
Set the highlighted indentation guide column. 0 = no highlighted guide.
Set the number of spaces used for one level of indentation.
Show or hide indentation guides.
Change the indentation of a line to a number of columns.
Sets whether a tab pressed when caret is within indentation indents.
Change the visible size of a tab to be a multiple of the width of a space character.
Indentation will only use space characters if useTabs is false, otherwise it will use a combination of tabs and spaces.
Add a marker to a line, returning an ID which can be used to find or delete the marker.
Add a set of markers to a line.
Set the symbol used for a particular marker number, and optionally the fore and background colours.
Define a marker from a bitmap
Delete a marker from a line.
Delete all markers with a particular number from all lines.
Delete a marker.
Get a bit mask of all the markers set on a line.
Retrieve the line number at which a particular marker is located.
Find the next line after lineStart that includes a marker in mask.
Find the previous line before lineStart that includes a marker in mask.
Set the alpha used for a marker that is drawn in the text area, not the margin.
Set the background colour used for a particular marker number.
Set the foreground colour used for a particular marker number.
Returns the size in pixels of the left margin.
Retrieve the marker mask of a margin.
Returns the size in pixels of the right margin.
Retrieve the mouse click sensitivity of a margin.
Retrieve the type of a margin.
Retrieve the width of a margin in pixels.
Sets the size in pixels of the left margin.
Set a mask that determines which markers are displayed in a margin.
Sets the size in pixels of the right margin.
Make a margin sensitive or insensitive to mouse clicks.
Set a margin to be either numeric or symbolic.
Set the width of a margin to a width expressed in pixels.
Set the left and right margin in the edit area, measured in pixels.
Retrieve the colour used in edge indication.
Retrieve the column number which text should be kept within.
Retrieve the edge highlight mode.
Change the colour used in edge indication.
Set the column number of the edge. If text goes past the edge then it is highlighted.
The edge may be displayed by a line (EDGE_LINE) or by highlighting text that goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
Find the document line of a display line taking hidden lines into account.
Ensure a particular line is visible by expanding any header line hiding it.
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.
Is a header line expanded?
Retrieve the fold level of a line.
Find the parent line of a child line.
Find the last child line of a header line.
Is a line visible?
Make a range of lines invisible.
Show the children of a header line.
Set some style options for folding.
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.
Set the colours used as a chequerboard pattern in the fold margin
Make a range of lines visible.
Switch a header line between expanded and contracted.
Find the display line of a document line taking hidden lines into account.
Highlight the character at a position indicating there is no matching brace.
Highlight the characters at two positions.
Find the position of a matching brace or INVALID_POSITION if no match.
Is there an auto-completion list visible?
Remove the auto-completion list from the screen.
User has selected an item so remove the list and insert the selection.
Retrieve whether or not autocompletion is hidden automatically when nothing matches.
Retrieve whether auto-completion cancelled by backspacing before start.
Retrieve whether a single item auto-completion list automatically choose the item.
Get currently selected item position in the auto-completion list
Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion.
Retrieve state of ignore case flag.
Set the maximum height, in rows, of auto-completion and user lists.
Get the maximum width, in characters, of auto-completion and user lists.
Retrieve the auto-completion list separator character.
Retrieve the auto-completion list type-separator character.
Retrieve the position of the caret when the auto-completion list was displayed.
Select the item in the auto-completion list that starts with a string.
Set whether or not autocompletion is hidden automatically when nothing matches.
Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created.
Should a single item auto-completion list automatically choose the item.
Set whether or not autocompletion deletes any word characters after the inserted text upon completion.
Define a set of characters that when typed will cause the autocompletion to choose the selected item.
Set whether case is significant when performing auto-completion searches.
Set the maximum height, in rows, of auto-completion and user lists. The default is 5 rows.
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.
Change the separator character in the string setting up an auto-completion list. Default is space but can be changed if items contain space.
Change the type-separator character in the string setting up an auto-completion list. Default is ‘?’ but can be changed if items contain ‘?’.
Display a auto-completion list. The lenEntered parameter indicates how many characters before the caret should be used to provide context.
Define a set of character that when typed cancel the auto-completion list.
Clear all the registered images.
Register an image for use in autocompletion lists.
Display a list of strings and send notification when user chooses one.
Is there an active call tip?
Remove the call tip from the screen.
Retrieve the position where the caret was before displaying the call tip.
Set the background colour for the call tip.
Set the foreground colour for the call tip.
Set the foreground colour for the highlighted part of the call tip.
Highlight a segment of the definition.
Show a call tip containing a definition near position pos.
Enable use of STYLE_CALLTIP and set call tip tab size in pixels.
Are white space characters currently visible? Returns one of SCWS_* constants.
Retrieve the zoom level.
Retrieves the number of lines completely visible.
Make white space characters invisible, always visible or visible outside indentation.
Set the background colour of all whitespace and whether to use this setting.
Set the foreground colour of all whitespace and whether to use this setting.
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.
Magnify the displayed text by increasing the sizes by 1 point.
Make the displayed text smaller by decreasing the sizes by 1 point.
Extend life of document.
Create a new document object. Starts with reference count of 1 and not selected into editor.
Retrieve a pointer to the document object.
Release a reference to the document, deleting document if it fades to black.
Change the document object used.
Is there an auto-completion list visible?
Remove the auto-completion list from the screen.
User has selected an item so remove the list and insert the selection.
Retrieve whether or not autocompletion is hidden automatically when nothing matches.
Retrieve whether auto-completion cancelled by backspacing before start.
Retrieve whether a single item auto-completion list automatically choose the item.
Get currently selected item position in the auto-completion list
Retrieve whether or not autocompletion deletes any word characters after the inserted text upon completion.
Retrieve state of ignore case flag.
Set the maximum height, in rows, of auto-completion and user lists.
Get the maximum width, in characters, of auto-completion and user lists.
Retrieve the auto-completion list separator character.
Retrieve the auto-completion list type-separator character.
Retrieve the position of the caret when the auto-completion list was displayed.
Select the item in the auto-completion list that starts with a string.
Set whether or not autocompletion is hidden automatically when nothing matches.
Should the auto-completion list be cancelled if the user backspaces to a position before where the box was created.
Should a single item auto-completion list automatically choose the item.
Set whether or not autocompletion deletes any word characters after the inserted text upon completion.
Define a set of characters that when typed will cause the autocompletion to choose the selected item.
Set whether case is significant when performing auto-completion searches.
Set the maximum height, in rows, of auto-completion and user lists. The default is 5 rows.
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.
Change the separator character in the string setting up an auto-completion list. Default is space but can be changed if items contain space.
Change the type-separator character in the string setting up an auto-completion list. Default is ‘?’ but can be changed if items contain ‘?’.
Display a auto-completion list. The lenEntered parameter indicates how many characters before the caret should be used to provide context.
Define a set of character that when typed cancel the auto-completion list.
Clear all the registered images.
Register an image for use in autocompletion lists.
Display a list of strings and send notification when user chooses one.
Is there an active call tip?
Remove the call tip from the screen.
Retrieve the position where the caret was before displaying the call tip.
Set the background colour for the call tip.
Set the foreground colour for the call tip.
Set the foreground colour for the highlighted part of the call tip.
Highlight a segment of the definition.
Show a call tip containing a definition near position pos.
Enable use of STYLE_CALLTIP and set call tip tab size in pixels.
When key+modifier combination km is pressed perform msg.
When key+modifier combination km is pressed do nothing.
Drop all key mappings.
Perform one of the operations defined by the wxSTC_CMD_* constants.
Dedent the selected lines.
Cancel any modes such as call tip or auto-completion list display.
Move caret left one character.
Move caret left one character extending selection to new caret position.
Move caret left one character, extending rectangular selection to new caret position.
Move caret right one character.
Move caret right one character extending selection to new caret position.
Move caret right one character, extending rectangular selection to new caret position.
Delete back from the current position to the start of the line.
Delete forwards from the current position to the end of the line.
Delete the word to the left of the caret.
Delete the word to the right of the caret.
Delete the selection or if no selection, the character before the caret.
Delete the selection or if no selection, the character before the caret. Will not delete the character before at the start of a line.
Move caret to last position in document.
Move caret to last position in document extending selection to new caret position.
Move caret to first position in document.
Move caret to first position in document extending selection to new caret position.
Switch from insert to overtype mode or the reverse.
Insert a Form Feed character.
Move caret to first position on line.
Move caret to first position on display line.
Move caret to first position on display line extending selection to new caret position.
Move caret to first position on line extending selection to new caret position.
Move caret to first position on line, extending rectangular selection to new caret position.
These are like their namesakes Home(Extend)?, LineEnd(Extend)?, VCHome(Extend)? except they behave differently when word-wrap is enabled: They go first to the start / end of the display line, like (Home|LineEnd)Display The difference is that, the cursor is already at the point, it goes on to the start or end of the document line, as appropriate for (Home|LineEnd|VCHome)(Extend)?.
Copy the line containing the caret.
Cut the line containing the caret.
Delete the line containing the caret.
Move caret down one line extending selection to new caret position.
Move caret down one line, extending rectangular selection to new caret position.
Duplicate the current line.
Move caret to last position on line.
Move caret to last position on display line.
Move caret to last position on display line extending selection to new caret position.
Move caret to last position on line extending selection to new caret position.
Move caret to last position on line, extending rectangular selection to new caret position.
Scroll the document down, keeping the caret visible.
Scroll the document up, keeping the caret visible.
Switch the current line with the previous.
Move caret up one line.
Move caret up one line extending selection to new caret position.
Move caret up one line, extending rectangular selection to new caret position.
Transform the selection to lower case.
Insert a new line, may use a CRLF, CR or LF depending on EOL mode.
Move caret one page down.
Move caret one page down extending selection to new caret position.
Move caret one page down, extending rectangular selection to new caret position.
Move caret one page up.
Move caret one page up extending selection to new caret position.
Move caret one page up, extending rectangular selection to new caret position.
Move caret between paragraphs (delimited by empty lines).
Duplicate the selection. If selection empty duplicate the line containing the caret.
Move caret to bottom of page, or one page down if already at bottom of page.
Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.
Move caret to top of page, or one page up if already at top of page.
Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.
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.
Transform the selection to upper case.
Move caret to before first visible character on line. If already there move to first character on line.
Like VCHome but extending selection to new caret position.
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.
Move caret left one word.
Move caret left one word, position cursor at end of word.
Move caret left one word, position cursor at end of word, extending selection to new caret position.
Move caret left one word extending selection to new caret position.
Move to the previous change in capitalisation.
Move to the previous change in capitalisation extending selection to new caret position.
Move to the change next in capitalisation.
Move to the next change in capitalisation extending selection to new caret position.
Move caret right one word.
Move caret right one word, position cursor at end of word.
Move caret right one word, position cursor at end of word, extending selection to new caret position.
Move caret right one word extending selection to new caret position.
Start notifying the container of all key presses and commands.
Stop notifying the container of all key presses and commands.
Load the contents of filename into the editor
} Write the contents of the editor to filename
On Windows, will draw the document into a display context such as a printer.
Returns the print colour mode.
Returns the print magnification.
Is printing line wrapped?
Modify colours when printing for clearer printed text.
Sets the print magnification added to the point size of each style for printing.
Set printing to line wrapped (SC_WRAP_WORD) or not line wrapped (SC_WRAP_NONE).
#ifdef STC_USE_DND Allow for simulating a DnD DragOver
Allow for simulating a DnD DropText
Get whether mouse gets captured.
Get error status.
Get internal focus flag.
Set whether the mouse is captured when its button is pressed.
Change error status – 0 = OK.
Change internal focus flag.
Can be used to prevent the EVT_CHAR handler from adding the char
Get which document modification events are sent to the container.
Retrieve the time the mouse must sit still to generate a mouse dwell event.
}
Set which document modification events are sent to the container.
Sets the time the mouse must sit still to generate a mouse dwell event.
Is drawing done first into a buffer or direct to the screen?
Is drawing done in two phases with backgrounds drawn before foregrounds?
Returns the current UseAntiAliasing setting.
If drawing is buffered then each line of text is drawn into a bitmap buffer before drawing it to the screen to avoid flicker.
Reset the set of characters for whitespace and word characters to the defaults.
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.
#endif Specify whether anti-aliased fonts should be used. Will have no effect on some platforms, but on some (wxMac for example) can greatly improve performance.
Set the set of characters making up whitespace for when moving or selecting by word. Should be called after SetWordChars.
Set the set of characters making up words for when moving or selecting by word. First sets deaults like SetCharsDefault.
Set whether a pop up menu is displayed automatically when the user presses the wrong mouse button.
[This page automatically generated from the Textile source at 2023-06-09 00:45:33 +0000]