1 ////////////////////////////////////////////////////////////////////////////
3 // Purpose: A wxWindows implementation of Scintilla. This class is the
4 // one meant to be used directly by wx applications. It does not
5 // derive directly from the Scintilla classes, but instead
6 // delegates most things to the real Scintilla class.
7 // This allows the use of Scintilla without polluting the
8 // namespace with all the classes and identifiers from Scintilla.
12 // Created: 13-Jan-2000
14 // Copyright: (c) 2000 by Total Control Software
15 // Licence: wxWindows license
16 /////////////////////////////////////////////////////////////////////////////
20 #include "wx/stc/stc.h"
21 #include "ScintillaWX.h"
23 #include <wx/tokenzr.h>
25 // The following code forces a reference to all of the Scintilla lexers.
26 // If we don't do something like this, then the linker tends to "optimize"
27 // them away. (eric@sourcegear.com)
29 int wxForceScintillaLexers(void)
31 extern LexerModule lmAda
;
32 extern LexerModule lmAVE
;
33 extern LexerModule lmConf
;
34 extern LexerModule lmCPP
;
35 extern LexerModule lmNncrontab
;
36 extern LexerModule lmEiffel
;
37 extern LexerModule lmHTML
;
38 extern LexerModule lmLISP
;
39 extern LexerModule lmLua
;
40 extern LexerModule lmBatch
; // In LexOthers.cxx
41 extern LexerModule lmPascal
;
42 extern LexerModule lmPerl
;
43 extern LexerModule lmPython
;
44 extern LexerModule lmRuby
;
45 extern LexerModule lmSQL
;
46 extern LexerModule lmVB
;
73 //----------------------------------------------------------------------
75 const wxChar
* wxSTCNameStr
= "stcwindow";
77 DEFINE_EVENT_TYPE( wxEVT_STC_CHANGE
)
78 DEFINE_EVENT_TYPE( wxEVT_STC_STYLENEEDED
)
79 DEFINE_EVENT_TYPE( wxEVT_STC_CHARADDED
)
80 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTREACHED
)
81 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTLEFT
)
82 DEFINE_EVENT_TYPE( wxEVT_STC_ROMODIFYATTEMPT
)
83 DEFINE_EVENT_TYPE( wxEVT_STC_KEY
)
84 DEFINE_EVENT_TYPE( wxEVT_STC_DOUBLECLICK
)
85 DEFINE_EVENT_TYPE( wxEVT_STC_UPDATEUI
)
86 DEFINE_EVENT_TYPE( wxEVT_STC_MODIFIED
)
87 DEFINE_EVENT_TYPE( wxEVT_STC_MACRORECORD
)
88 DEFINE_EVENT_TYPE( wxEVT_STC_MARGINCLICK
)
89 DEFINE_EVENT_TYPE( wxEVT_STC_NEEDSHOWN
)
90 DEFINE_EVENT_TYPE( wxEVT_STC_POSCHANGED
)
91 DEFINE_EVENT_TYPE( wxEVT_STC_PAINTED
)
92 DEFINE_EVENT_TYPE( wxEVT_STC_USERLISTSELECTION
)
93 DEFINE_EVENT_TYPE( wxEVT_STC_URIDROPPED
)
94 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLSTART
)
95 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLEND
)
96 #if wxUSE_DRAG_AND_DROP
97 DEFINE_EVENT_TYPE( wxEVT_STC_START_DRAG
)
98 DEFINE_EVENT_TYPE( wxEVT_STC_DRAG_OVER
)
99 DEFINE_EVENT_TYPE( wxEVT_STC_DO_DROP
)
103 BEGIN_EVENT_TABLE(wxStyledTextCtrl
, wxControl
)
104 EVT_PAINT (wxStyledTextCtrl::OnPaint
)
105 EVT_SCROLLWIN (wxStyledTextCtrl::OnScrollWin
)
106 EVT_SCROLL (wxStyledTextCtrl::OnScroll
)
107 EVT_SIZE (wxStyledTextCtrl::OnSize
)
108 EVT_LEFT_DOWN (wxStyledTextCtrl::OnMouseLeftDown
)
110 // Let Scintilla see the double click as a second click
111 EVT_LEFT_DCLICK (wxStyledTextCtrl::OnMouseLeftDown
)
113 EVT_MOTION (wxStyledTextCtrl::OnMouseMove
)
114 EVT_LEFT_UP (wxStyledTextCtrl::OnMouseLeftUp
)
116 EVT_RIGHT_UP (wxStyledTextCtrl::OnMouseRightUp
)
118 EVT_CONTEXT_MENU (wxStyledTextCtrl::OnContextMenu
)
120 EVT_MOUSEWHEEL (wxStyledTextCtrl::OnMouseWheel
)
121 EVT_CHAR (wxStyledTextCtrl::OnChar
)
122 EVT_KEY_DOWN (wxStyledTextCtrl::OnKeyDown
)
123 EVT_KILL_FOCUS (wxStyledTextCtrl::OnLoseFocus
)
124 EVT_SET_FOCUS (wxStyledTextCtrl::OnGainFocus
)
125 EVT_SYS_COLOUR_CHANGED (wxStyledTextCtrl::OnSysColourChanged
)
126 EVT_ERASE_BACKGROUND (wxStyledTextCtrl::OnEraseBackground
)
127 EVT_MENU_RANGE (-1, -1, wxStyledTextCtrl::OnMenu
)
128 EVT_LISTBOX_DCLICK (-1, wxStyledTextCtrl::OnListBox
)
132 IMPLEMENT_CLASS(wxStyledTextCtrl
, wxControl
)
133 IMPLEMENT_DYNAMIC_CLASS(wxStyledTextEvent
, wxCommandEvent
)
135 //----------------------------------------------------------------------
136 // Constructor and Destructor
138 wxStyledTextCtrl::wxStyledTextCtrl(wxWindow
*parent
,
143 const wxString
& name
) :
144 wxControl(parent
, id
, pos
, size
,
145 style
| wxVSCROLL
| wxHSCROLL
| wxWANTS_CHARS
| wxCLIP_CHILDREN
,
146 wxDefaultValidator
, name
)
148 m_swx
= new ScintillaWX(this);
150 m_lastKeyDownConsumed
= FALSE
;
156 wxStyledTextCtrl::~wxStyledTextCtrl() {
161 //----------------------------------------------------------------------
163 long wxStyledTextCtrl::SendMsg(int msg
, long wp
, long lp
) {
165 return m_swx
->WndProc(msg
, wp
, lp
);
173 #define MAKELONG(a, b) ((a) | ((b) << 16))
176 static long wxColourAsLong(const wxColour
& co
) {
177 return (((long)co
.Blue() << 16) |
178 ((long)co
.Green() << 8) |
182 static wxColour
wxColourFromLong(long c
) {
184 clr
.Set(c
& 0xff, (c
>> 8) & 0xff, (c
>> 16) & 0xff);
189 static wxColour
wxColourFromSpec(const wxString
& spec
) {
190 // spec should be #RRGGBB
192 int red
= strtol(spec
.Mid(1,2), &junk
, 16);
193 int green
= strtol(spec
.Mid(3,2), &junk
, 16);
194 int blue
= strtol(spec
.Mid(5,2), &junk
, 16);
195 return wxColour(red
, green
, blue
);
199 //----------------------------------------------------------------------
200 // BEGIN generated section. The following code is automatically generated
201 // by gen_iface.py from the contents of Scintilla.iface. Do not edit
202 // this file. Edit stc.cpp.in or gen_iface.py instead and regenerate.
205 // Add text to the document
206 void wxStyledTextCtrl::AddText(const wxString
& text
) {
207 SendMsg(2001, text
.Len(), (long)text
.c_str());
210 // Add array of cells to document
211 void wxStyledTextCtrl::AddStyledText(const wxString
& text
) {
212 SendMsg(2002, text
.Len(), (long)text
.c_str());
215 // Insert string at a position
216 void wxStyledTextCtrl::InsertText(int pos
, const wxString
& text
) {
217 SendMsg(2003, pos
, (long)text
.c_str());
220 // Delete all text in the document
221 void wxStyledTextCtrl::ClearAll() {
225 // Set all style bytes to 0, remove all folding information
226 void wxStyledTextCtrl::ClearDocumentStyle() {
230 // The number of characters in the document
231 int wxStyledTextCtrl::GetLength() {
232 return SendMsg(2006, 0, 0);
235 // Returns the character byte at the position
236 int wxStyledTextCtrl::GetCharAt(int pos
) {
237 return SendMsg(2007, pos
, 0);
240 // Returns the position of the caret
241 int wxStyledTextCtrl::GetCurrentPos() {
242 return SendMsg(2008, 0, 0);
245 // Returns the position of the opposite end of the selection to the caret
246 int wxStyledTextCtrl::GetAnchor() {
247 return SendMsg(2009, 0, 0);
250 // Returns the style byte at the position
251 int wxStyledTextCtrl::GetStyleAt(int pos
) {
252 return SendMsg(2010, pos
, 0);
255 // Redoes the next action on the undo history
256 void wxStyledTextCtrl::Redo() {
260 // Choose between collecting actions into the undo
261 // history and discarding them.
262 void wxStyledTextCtrl::SetUndoCollection(bool collectUndo
) {
263 SendMsg(2012, collectUndo
, 0);
266 // Select all the text in the document.
267 void wxStyledTextCtrl::SelectAll() {
271 // Remember the current position in the undo history as the position
272 // at which the document was saved.
273 void wxStyledTextCtrl::SetSavePoint() {
277 // Retrieve a buffer of cells.
278 wxString
wxStyledTextCtrl::GetStyledText(int startPos
, int endPos
) {
280 int len
= endPos
- startPos
;
283 tr
.lpstrText
= text
.GetWriteBuf(len
*2);
284 tr
.chrg
.cpMin
= startPos
;
285 tr
.chrg
.cpMax
= endPos
;
286 SendMsg(2015, 0, (long)&tr
);
287 text
.UngetWriteBuf(len
*2);
291 // Are there any redoable actions in the undo history.
292 bool wxStyledTextCtrl::CanRedo() {
293 return SendMsg(2016, 0, 0) != 0;
296 // Retrieve the line number at which a particular marker is located
297 int wxStyledTextCtrl::MarkerLineFromHandle(int handle
) {
298 return SendMsg(2017, handle
, 0);
302 void wxStyledTextCtrl::MarkerDeleteHandle(int handle
) {
303 SendMsg(2018, handle
, 0);
306 // Is undo history being collected?
307 bool wxStyledTextCtrl::GetUndoCollection() {
308 return SendMsg(2019, 0, 0) != 0;
311 // Are white space characters currently visible?
312 // Returns one of SCWS_* constants.
313 int wxStyledTextCtrl::GetViewWhiteSpace() {
314 return SendMsg(2020, 0, 0);
317 // Make white space characters invisible, always visible or visible outside indentation.
318 void wxStyledTextCtrl::SetViewWhiteSpace(int viewWS
) {
319 SendMsg(2021, viewWS
, 0);
322 // Find the position from a point within the window.
323 int wxStyledTextCtrl::PositionFromPoint(wxPoint pt
) {
324 return SendMsg(2022, pt
.x
, pt
.y
);
327 // Find the position from a point within the window but return
328 // INVALID_POSITION if not close to text.
329 int wxStyledTextCtrl::PositionFromPointClose(int x
, int y
) {
330 return SendMsg(2023, x
, y
);
333 // Set caret to start of a line and ensure it is visible.
334 void wxStyledTextCtrl::GotoLine(int line
) {
335 SendMsg(2024, line
, 0);
338 // Set caret to a position and ensure it is visible.
339 void wxStyledTextCtrl::GotoPos(int pos
) {
340 SendMsg(2025, pos
, 0);
343 // Set the selection anchor to a position. The anchor is the opposite
344 // end of the selection from the caret.
345 void wxStyledTextCtrl::SetAnchor(int posAnchor
) {
346 SendMsg(2026, posAnchor
, 0);
349 // Retrieve the text of the line containing the caret.
350 // Returns the index of the caret on the line.
351 wxString
wxStyledTextCtrl::GetCurLine(int* linePos
) {
353 int len
= LineLength(GetCurrentLine());
355 if (linePos
) *linePos
= 0;
358 // Need an extra byte because SCI_GETCURLINE writes a null to the string
359 char* buf
= text
.GetWriteBuf(len
+1);
361 int pos
= SendMsg(2027, len
+1, (long)buf
);
362 text
.UngetWriteBuf(len
);
363 if (linePos
) *linePos
= pos
;
368 // Retrieve the position of the last correctly styled character.
369 int wxStyledTextCtrl::GetEndStyled() {
370 return SendMsg(2028, 0, 0);
373 // Convert all line endings in the document to one mode.
374 void wxStyledTextCtrl::ConvertEOLs(int eolMode
) {
375 SendMsg(2029, eolMode
, 0);
378 // Retrieve the current end of line mode - one of CRLF, CR, or LF.
379 int wxStyledTextCtrl::GetEOLMode() {
380 return SendMsg(2030, 0, 0);
383 // Set the current end of line mode.
384 void wxStyledTextCtrl::SetEOLMode(int eolMode
) {
385 SendMsg(2031, eolMode
, 0);
388 // Set the current styling position to pos and the styling mask to mask.
389 // The styling mask can be used to protect some bits in each styling byte from
391 void wxStyledTextCtrl::StartStyling(int pos
, int mask
) {
392 SendMsg(2032, pos
, mask
);
395 // Change style from current styling position for length characters to a style
396 // and move the current styling position to after this newly styled segment.
397 void wxStyledTextCtrl::SetStyling(int length
, int style
) {
398 SendMsg(2033, length
, style
);
401 // Is drawing done first into a buffer or direct to the screen.
402 bool wxStyledTextCtrl::GetBufferedDraw() {
403 return SendMsg(2034, 0, 0) != 0;
406 // If drawing is buffered then each line of text is drawn into a bitmap buffer
407 // before drawing it to the screen to avoid flicker.
408 void wxStyledTextCtrl::SetBufferedDraw(bool buffered
) {
409 SendMsg(2035, buffered
, 0);
412 // Change the visible size of a tab to be a multiple of the width of a space
414 void wxStyledTextCtrl::SetTabWidth(int tabWidth
) {
415 SendMsg(2036, tabWidth
, 0);
418 // Retrieve the visible size of a tab.
419 int wxStyledTextCtrl::GetTabWidth() {
420 return SendMsg(2121, 0, 0);
423 // Set the code page used to interpret the bytes of the document as characters.
424 // The SC_CP_UTF8 value can be used to enter Unicode mode.
425 void wxStyledTextCtrl::SetCodePage(int codePage
) {
426 SendMsg(2037, codePage
, 0);
429 // Set the symbol used for a particular marker number,
430 // and optionally the for and background colours.
431 void wxStyledTextCtrl::MarkerDefine(int markerNumber
, int markerSymbol
,
432 const wxColour
& foreground
,
433 const wxColour
& background
) {
435 SendMsg(2040, markerNumber
, markerSymbol
);
437 MarkerSetForeground(markerNumber
, foreground
);
439 MarkerSetBackground(markerNumber
, background
);
442 // Set the foreground colour used for a particular marker number.
443 void wxStyledTextCtrl::MarkerSetForeground(int markerNumber
, const wxColour
& fore
) {
444 SendMsg(2041, markerNumber
, wxColourAsLong(fore
));
447 // Set the background colour used for a particular marker number.
448 void wxStyledTextCtrl::MarkerSetBackground(int markerNumber
, const wxColour
& back
) {
449 SendMsg(2042, markerNumber
, wxColourAsLong(back
));
452 // Add a marker to a line.
453 void wxStyledTextCtrl::MarkerAdd(int line
, int markerNumber
) {
454 SendMsg(2043, line
, markerNumber
);
457 // Delete a marker from a line
458 void wxStyledTextCtrl::MarkerDelete(int line
, int markerNumber
) {
459 SendMsg(2044, line
, markerNumber
);
462 // Delete all markers with a particular number from all lines
463 void wxStyledTextCtrl::MarkerDeleteAll(int markerNumber
) {
464 SendMsg(2045, markerNumber
, 0);
467 // Get a bit mask of all the markers set on a line.
468 int wxStyledTextCtrl::MarkerGet(int line
) {
469 return SendMsg(2046, line
, 0);
472 // Find the next line after lineStart that includes a marker in mask.
473 int wxStyledTextCtrl::MarkerNext(int lineStart
, int markerMask
) {
474 return SendMsg(2047, lineStart
, markerMask
);
477 // Find the previous line before lineStart that includes a marker in mask.
478 int wxStyledTextCtrl::MarkerPrevious(int lineStart
, int markerMask
) {
479 return SendMsg(2048, lineStart
, markerMask
);
482 // Set a margin to be either numeric or symbolic.
483 void wxStyledTextCtrl::SetMarginType(int margin
, int marginType
) {
484 SendMsg(2240, margin
, marginType
);
487 // Retrieve the type of a margin.
488 int wxStyledTextCtrl::GetMarginType(int margin
) {
489 return SendMsg(2241, margin
, 0);
492 // Set the width of a margin to a width expressed in pixels.
493 void wxStyledTextCtrl::SetMarginWidth(int margin
, int pixelWidth
) {
494 SendMsg(2242, margin
, pixelWidth
);
497 // Retrieve the width of a margin in pixels.
498 int wxStyledTextCtrl::GetMarginWidth(int margin
) {
499 return SendMsg(2243, margin
, 0);
502 // Set a mask that determines which markers are displayed in a margin.
503 void wxStyledTextCtrl::SetMarginMask(int margin
, int mask
) {
504 SendMsg(2244, margin
, mask
);
507 // Retrieve the marker mask of a margin.
508 int wxStyledTextCtrl::GetMarginMask(int margin
) {
509 return SendMsg(2245, margin
, 0);
512 // Make a margin sensitive or insensitive to mouse clicks.
513 void wxStyledTextCtrl::SetMarginSensitive(int margin
, bool sensitive
) {
514 SendMsg(2246, margin
, sensitive
);
517 // Retrieve the mouse click sensitivity of a margin.
518 bool wxStyledTextCtrl::GetMarginSensitive(int margin
) {
519 return SendMsg(2247, margin
, 0) != 0;
522 // Clear all the styles and make equivalent to the global default style.
523 void wxStyledTextCtrl::StyleClearAll() {
527 // Set the foreground colour of a style.
528 void wxStyledTextCtrl::StyleSetForeground(int style
, const wxColour
& fore
) {
529 SendMsg(2051, style
, wxColourAsLong(fore
));
532 // Set the background colour of a style.
533 void wxStyledTextCtrl::StyleSetBackground(int style
, const wxColour
& back
) {
534 SendMsg(2052, style
, wxColourAsLong(back
));
537 // Set a style to be bold or not.
538 void wxStyledTextCtrl::StyleSetBold(int style
, bool bold
) {
539 SendMsg(2053, style
, bold
);
542 // Set a style to be italic or not.
543 void wxStyledTextCtrl::StyleSetItalic(int style
, bool italic
) {
544 SendMsg(2054, style
, italic
);
547 // Set the size of characters of a style.
548 void wxStyledTextCtrl::StyleSetSize(int style
, int sizePoints
) {
549 SendMsg(2055, style
, sizePoints
);
552 // Set the font of a style.
553 void wxStyledTextCtrl::StyleSetFaceName(int style
, const wxString
& fontName
) {
554 SendMsg(2056, style
, (long)fontName
.c_str());
557 // Set a style to have its end of line filled or not.
558 void wxStyledTextCtrl::StyleSetEOLFilled(int style
, bool filled
) {
559 SendMsg(2057, style
, filled
);
562 // Reset the default style to its state at startup
563 void wxStyledTextCtrl::StyleResetDefault() {
567 // Set a style to be underlined or not.
568 void wxStyledTextCtrl::StyleSetUnderline(int style
, bool underline
) {
569 SendMsg(2059, style
, underline
);
572 // Set a style to be mixed case, or to force upper or lower case.
573 void wxStyledTextCtrl::StyleSetCase(int style
, int caseForce
) {
574 SendMsg(2060, style
, caseForce
);
577 // Set the foreground colour of the selection and whether to use this setting.
578 void wxStyledTextCtrl::SetSelForeground(bool useSetting
, const wxColour
& fore
) {
579 SendMsg(2067, useSetting
, wxColourAsLong(fore
));
582 // Set the background colour of the selection and whether to use this setting.
583 void wxStyledTextCtrl::SetSelBackground(bool useSetting
, const wxColour
& back
) {
584 SendMsg(2068, useSetting
, wxColourAsLong(back
));
587 // Set the foreground colour of the caret.
588 void wxStyledTextCtrl::SetCaretForeground(const wxColour
& fore
) {
589 SendMsg(2069, wxColourAsLong(fore
), 0);
592 // When key+modifier combination km is pressed perform msg.
593 void wxStyledTextCtrl::CmdKeyAssign(int key
, int modifiers
, int cmd
) {
594 SendMsg(2070, MAKELONG(key
, modifiers
), cmd
);
597 // When key+modifier combination km do nothing.
598 void wxStyledTextCtrl::CmdKeyClear(int key
, int modifiers
) {
599 SendMsg(2071, MAKELONG(key
, modifiers
));
602 // Drop all key mappings.
603 void wxStyledTextCtrl::CmdKeyClearAll() {
607 // Set the styles for a segment of the document.
608 void wxStyledTextCtrl::SetStyleBytes(int length
, char* styleBytes
) {
609 SendMsg(2073, length
, (long)styleBytes
);
612 // Set a style to be visible or not.
613 void wxStyledTextCtrl::StyleSetVisible(int style
, bool visible
) {
614 SendMsg(2074, style
, visible
);
617 // Get the time in milliseconds that the caret is on and off.
618 int wxStyledTextCtrl::GetCaretPeriod() {
619 return SendMsg(2075, 0, 0);
622 // Get the time in milliseconds that the caret is on and off. 0 = steady on.
623 void wxStyledTextCtrl::SetCaretPeriod(int periodMilliseconds
) {
624 SendMsg(2076, periodMilliseconds
, 0);
627 // Set the set of characters making up words for when moving or selecting
629 void wxStyledTextCtrl::SetWordChars(const wxString
& characters
) {
630 SendMsg(2077, 0, (long)characters
.c_str());
633 // Start a sequence of actions that is undone and redone as a unit.
635 void wxStyledTextCtrl::BeginUndoAction() {
639 // End a sequence of actions that is undone and redone as a unit.
640 void wxStyledTextCtrl::EndUndoAction() {
644 // Set an indicator to plain, squiggle or TT.
645 void wxStyledTextCtrl::IndicatorSetStyle(int indic
, int style
) {
646 SendMsg(2080, indic
, style
);
649 // Retrieve the style of an indicator.
650 int wxStyledTextCtrl::IndicatorGetStyle(int indic
) {
651 return SendMsg(2081, indic
, 0);
654 // Set the foreground colour of an indicator.
655 void wxStyledTextCtrl::IndicatorSetForeground(int indic
, const wxColour
& fore
) {
656 SendMsg(2082, indic
, wxColourAsLong(fore
));
659 // Retrieve the foreground colour of an indicator.
660 wxColour
wxStyledTextCtrl::IndicatorGetForeground(int indic
) {
661 long c
= SendMsg(2083, indic
, 0);
662 return wxColourFromLong(c
);
665 // Divide each styling byte into lexical class bits (default:5) and indicator
666 // bits (default:3). If a lexer requires more than 32 lexical states, then this
667 // is used to expand the possible states.
668 void wxStyledTextCtrl::SetStyleBits(int bits
) {
669 SendMsg(2090, bits
, 0);
672 // Retrieve number of bits in style bytes used to hold the lexical state.
673 int wxStyledTextCtrl::GetStyleBits() {
674 return SendMsg(2091, 0, 0);
677 // Used to hold extra styling information for each line.
678 void wxStyledTextCtrl::SetLineState(int line
, int state
) {
679 SendMsg(2092, line
, state
);
682 // Retrieve the extra styling information for a line.
683 int wxStyledTextCtrl::GetLineState(int line
) {
684 return SendMsg(2093, line
, 0);
687 // Retrieve the last line number that has line state.
688 int wxStyledTextCtrl::GetMaxLineState() {
689 return SendMsg(2094, 0, 0);
692 // Is the background of the line containing the caret in a different colour?
693 bool wxStyledTextCtrl::GetCaretLineVisible() {
694 return SendMsg(2095, 0, 0) != 0;
697 // Display the background of the line containing the caret in a different colour.
698 void wxStyledTextCtrl::SetCaretLineVisible(bool show
) {
699 SendMsg(2096, show
, 0);
702 // Get the colour of the background of the line containing the caret.
703 wxColour
wxStyledTextCtrl::GetCaretLineBack() {
704 long c
= SendMsg(2097, 0, 0);
705 return wxColourFromLong(c
);
708 // Set the colour of the background of the line containing the caret.
709 void wxStyledTextCtrl::SetCaretLineBack(const wxColour
& back
) {
710 SendMsg(2098, wxColourAsLong(back
), 0);
713 // Display a auto-completion list.
714 // The lenEntered parameter indicates how many characters before
715 // the caret should be used to provide context.
716 void wxStyledTextCtrl::AutoCompShow(int lenEntered
, const wxString
& itemList
) {
717 SendMsg(2100, lenEntered
, (long)itemList
.c_str());
720 // Remove the auto-completion list from the screen.
721 void wxStyledTextCtrl::AutoCompCancel() {
725 // Is there an auto-completion list visible?
726 bool wxStyledTextCtrl::AutoCompActive() {
727 return SendMsg(2102, 0, 0) != 0;
730 // Retrieve the position of the caret when the auto-completion list was
732 int wxStyledTextCtrl::AutoCompPosStart() {
733 return SendMsg(2103, 0, 0);
736 // User has selected an item so remove the list and insert the selection.
737 void wxStyledTextCtrl::AutoCompComplete() {
741 // Define a set of character that when typed cancel the auto-completion list.
742 void wxStyledTextCtrl::AutoCompStops(const wxString
& characterSet
) {
743 SendMsg(2105, 0, (long)characterSet
.c_str());
746 // Change the separator character in the string setting up an auto-completion
747 // list. Default is space but can be changed if items contain space.
748 void wxStyledTextCtrl::AutoCompSetSeparator(int separatorCharacter
) {
749 SendMsg(2106, separatorCharacter
, 0);
752 // Retrieve the auto-completion list separator character.
753 int wxStyledTextCtrl::AutoCompGetSeparator() {
754 return SendMsg(2107, 0, 0);
757 // Select the item in the auto-completion list that starts with a string.
758 void wxStyledTextCtrl::AutoCompSelect(const wxString
& text
) {
759 SendMsg(2108, 0, (long)text
.c_str());
762 // Should the auto-completion list be cancelled if the user backspaces to a
763 // position before where the box was created.
764 void wxStyledTextCtrl::AutoCompSetCancelAtStart(bool cancel
) {
765 SendMsg(2110, cancel
, 0);
768 // Retrieve whether auto-completion cancelled by backspacing before start.
769 bool wxStyledTextCtrl::AutoCompGetCancelAtStart() {
770 return SendMsg(2111, 0, 0) != 0;
773 // Define a set of character that when typed fills up the selected word.
774 void wxStyledTextCtrl::AutoCompSetFillUps(const wxString
& characterSet
) {
775 SendMsg(2112, 0, (long)characterSet
.c_str());
778 // Should a single item auto-completion list automatically choose the item.
779 void wxStyledTextCtrl::AutoCompSetChooseSingle(bool chooseSingle
) {
780 SendMsg(2113, chooseSingle
, 0);
783 // Retrieve whether a single item auto-completion list automatically choose the item.
784 bool wxStyledTextCtrl::AutoCompGetChooseSingle() {
785 return SendMsg(2114, 0, 0) != 0;
788 // Set whether case is significant when performing auto-completion searches.
789 void wxStyledTextCtrl::AutoCompSetIgnoreCase(bool ignoreCase
) {
790 SendMsg(2115, ignoreCase
, 0);
793 // Retrieve state of ignore case flag.
794 bool wxStyledTextCtrl::AutoCompGetIgnoreCase() {
795 return SendMsg(2116, 0, 0) != 0;
798 // Display a list of strings and send notification when user chooses one.
799 void wxStyledTextCtrl::UserListShow(int listType
, const wxString
& itemList
) {
800 SendMsg(2117, listType
, (long)itemList
.c_str());
803 // Set whether or not autocompletion is hidden automatically when nothing matches
804 void wxStyledTextCtrl::AutoCompSetAutoHide(bool autoHide
) {
805 SendMsg(2118, autoHide
, 0);
808 // Retrieve whether or not autocompletion is hidden automatically when nothing matches
809 bool wxStyledTextCtrl::AutoCompGetAutoHide() {
810 return SendMsg(2119, 0, 0) != 0;
813 // Set the number of spaces used for one level of indentation.
814 void wxStyledTextCtrl::SetIndent(int indentSize
) {
815 SendMsg(2122, indentSize
, 0);
818 // Retrieve indentation size.
819 int wxStyledTextCtrl::GetIndent() {
820 return SendMsg(2123, 0, 0);
823 // Indentation will only use space characters if useTabs is false, otherwise
824 // it will use a combination of tabs and spaces.
825 void wxStyledTextCtrl::SetUseTabs(bool useTabs
) {
826 SendMsg(2124, useTabs
, 0);
829 // Retrieve whether tabs will be used in indentation.
830 bool wxStyledTextCtrl::GetUseTabs() {
831 return SendMsg(2125, 0, 0) != 0;
834 // Change the indentation of a line to a number of columns.
835 void wxStyledTextCtrl::SetLineIndentation(int line
, int indentSize
) {
836 SendMsg(2126, line
, indentSize
);
839 // Retrieve the number of columns that a line is indented.
840 int wxStyledTextCtrl::GetLineIndentation(int line
) {
841 return SendMsg(2127, line
, 0);
844 // Retrieve the position before the first non indentation character on a line.
845 int wxStyledTextCtrl::GetLineIndentPosition(int line
) {
846 return SendMsg(2128, line
, 0);
849 // Retrieve the column number of a position, taking tab width into account.
850 int wxStyledTextCtrl::GetColumn(int pos
) {
851 return SendMsg(2129, pos
, 0);
854 // Show or hide the horizontal scroll bar.
855 void wxStyledTextCtrl::SetUseHorizontalScrollBar(bool show
) {
856 SendMsg(2130, show
, 0);
859 // Is the horizontal scroll bar visible?
860 bool wxStyledTextCtrl::GetUseHorizontalScrollBar() {
861 return SendMsg(2131, 0, 0) != 0;
864 // Show or hide indentation guides.
865 void wxStyledTextCtrl::SetIndentationGuides(bool show
) {
866 SendMsg(2132, show
, 0);
869 // Are the indentation guides visible?
870 bool wxStyledTextCtrl::GetIndentationGuides() {
871 return SendMsg(2133, 0, 0) != 0;
874 // Set the highlighted indentation guide column.
875 // 0 = no highlighted guide.
876 void wxStyledTextCtrl::SetHighlightGuide(int column
) {
877 SendMsg(2134, column
, 0);
880 // Get the highlighted indentation guide column.
881 int wxStyledTextCtrl::GetHighlightGuide() {
882 return SendMsg(2135, 0, 0);
885 // Get the position after the last visible characters on a line.
886 int wxStyledTextCtrl::GetLineEndPosition(int line
) {
887 return SendMsg(2136, line
, 0);
890 // Get the code page used to interpret the bytes of the document as characters.
891 int wxStyledTextCtrl::GetCodePage() {
892 return SendMsg(2137, 0, 0);
895 // Get the foreground colour of the caret.
896 wxColour
wxStyledTextCtrl::GetCaretForeground() {
897 long c
= SendMsg(2138, 0, 0);
898 return wxColourFromLong(c
);
901 // In read-only mode?
902 bool wxStyledTextCtrl::GetReadOnly() {
903 return SendMsg(2140, 0, 0) != 0;
906 // Sets the position of the caret.
907 void wxStyledTextCtrl::SetCurrentPos(int pos
) {
908 SendMsg(2141, pos
, 0);
911 // Sets the position that starts the selection - this becomes the anchor.
912 void wxStyledTextCtrl::SetSelectionStart(int pos
) {
913 SendMsg(2142, pos
, 0);
916 // Returns the position at the start of the selection.
917 int wxStyledTextCtrl::GetSelectionStart() {
918 return SendMsg(2143, 0, 0);
921 // Sets the position that ends the selection - this becomes the currentPosition.
922 void wxStyledTextCtrl::SetSelectionEnd(int pos
) {
923 SendMsg(2144, pos
, 0);
926 // Returns the position at the end of the selection.
927 int wxStyledTextCtrl::GetSelectionEnd() {
928 return SendMsg(2145, 0, 0);
931 // Sets the print magnification added to the point size of each style for printing.
932 void wxStyledTextCtrl::SetPrintMagnification(int magnification
) {
933 SendMsg(2146, magnification
, 0);
936 // Returns the print magnification.
937 int wxStyledTextCtrl::GetPrintMagnification() {
938 return SendMsg(2147, 0, 0);
941 // Modify colours when printing for clearer printed text.
942 void wxStyledTextCtrl::SetPrintColourMode(int mode
) {
943 SendMsg(2148, mode
, 0);
946 // Returns the print colour mode.
947 int wxStyledTextCtrl::GetPrintColourMode() {
948 return SendMsg(2149, 0, 0);
951 // Find some text in the document.
952 int wxStyledTextCtrl::FindText(int minPos
, int maxPos
,
953 const wxString
& text
,
954 bool caseSensitive
, bool wholeWord
) {
958 flags
|= caseSensitive
? SCFIND_MATCHCASE
: 0;
959 flags
|= wholeWord
? SCFIND_WHOLEWORD
: 0;
960 ft
.chrg
.cpMin
= minPos
;
961 ft
.chrg
.cpMax
= maxPos
;
962 ft
.lpstrText
= (char*)text
.c_str();
964 return SendMsg(2150, flags
, (long)&ft
);
967 // On Windows will draw the document into a display context such as a printer.
968 int wxStyledTextCtrl::FormatRange(bool doDraw
,
972 wxDC
* target
, // Why does it use two? Can they be the same?
978 fr
.hdcTarget
= target
;
979 fr
.rc
.top
= renderRect
.GetTop();
980 fr
.rc
.left
= renderRect
.GetLeft();
981 fr
.rc
.right
= renderRect
.GetRight();
982 fr
.rc
.bottom
= renderRect
.GetBottom();
983 fr
.rcPage
.top
= pageRect
.GetTop();
984 fr
.rcPage
.left
= pageRect
.GetLeft();
985 fr
.rcPage
.right
= pageRect
.GetRight();
986 fr
.rcPage
.bottom
= pageRect
.GetBottom();
987 fr
.chrg
.cpMin
= startPos
;
988 fr
.chrg
.cpMax
= endPos
;
990 return SendMsg(2151, doDraw
, (long)&fr
);
993 // Retrieve the line at the top of the display.
994 int wxStyledTextCtrl::GetFirstVisibleLine() {
995 return SendMsg(2152, 0, 0);
998 // Retrieve the contents of a line.
999 wxString
wxStyledTextCtrl::GetLine(int line
) {
1001 int len
= LineLength(line
);
1002 if (!len
) return "";
1003 char* buf
= text
.GetWriteBuf(len
);
1005 int pos
= SendMsg(2153, line
, (long)buf
);
1006 text
.UngetWriteBuf(len
);
1011 // Returns the number of lines in the document. There is always at least one.
1012 int wxStyledTextCtrl::GetLineCount() {
1013 return SendMsg(2154, 0, 0);
1016 // Sets the size in pixels of the left margin.
1017 void wxStyledTextCtrl::SetMarginLeft(int pixelWidth
) {
1018 SendMsg(2155, 0, pixelWidth
);
1021 // Returns the size in pixels of the left margin.
1022 int wxStyledTextCtrl::GetMarginLeft() {
1023 return SendMsg(2156, 0, 0);
1026 // Sets the size in pixels of the right margin.
1027 void wxStyledTextCtrl::SetMarginRight(int pixelWidth
) {
1028 SendMsg(2157, 0, pixelWidth
);
1031 // Returns the size in pixels of the right margin.
1032 int wxStyledTextCtrl::GetMarginRight() {
1033 return SendMsg(2158, 0, 0);
1036 // Is the document different from when it was last saved?
1037 bool wxStyledTextCtrl::GetModify() {
1038 return SendMsg(2159, 0, 0) != 0;
1041 // Select a range of text.
1042 void wxStyledTextCtrl::SetSelection(int start
, int end
) {
1043 SendMsg(2160, start
, end
);
1046 // Retrieve the selected text.
1047 wxString
wxStyledTextCtrl::GetSelectedText() {
1052 GetSelection(&start
, &end
);
1053 int len
= end
- start
;
1054 if (!len
) return "";
1055 char* buff
= text
.GetWriteBuf(len
);
1057 SendMsg(2161, 0, (long)buff
);
1058 text
.UngetWriteBuf(len
);
1062 // Retrieve a range of text.
1063 wxString
wxStyledTextCtrl::GetTextRange(int startPos
, int endPos
) {
1065 int len
= endPos
- startPos
;
1066 if (!len
) return "";
1067 char* buff
= text
.GetWriteBuf(len
);
1069 tr
.lpstrText
= buff
;
1070 tr
.chrg
.cpMin
= startPos
;
1071 tr
.chrg
.cpMax
= endPos
;
1073 SendMsg(2162, 0, (long)&tr
);
1074 text
.UngetWriteBuf(len
);
1078 // Draw the selection in normal style or with selection highlighted.
1079 void wxStyledTextCtrl::HideSelection(bool normal
) {
1080 SendMsg(2163, normal
, 0);
1083 // Retrieve the line containing a position.
1084 int wxStyledTextCtrl::LineFromPosition(int pos
) {
1085 return SendMsg(2166, pos
, 0);
1088 // Retrieve the position at the start of a line.
1089 int wxStyledTextCtrl::PositionFromLine(int line
) {
1090 return SendMsg(2167, line
, 0);
1093 // Scroll horizontally and vertically.
1094 void wxStyledTextCtrl::LineScroll(int columns
, int lines
) {
1095 SendMsg(2168, columns
, lines
);
1098 // Ensure the caret is visible.
1099 void wxStyledTextCtrl::EnsureCaretVisible() {
1100 SendMsg(2169, 0, 0);
1103 // Replace the selected text with the argument text.
1104 void wxStyledTextCtrl::ReplaceSelection(const wxString
& text
) {
1105 SendMsg(2170, 0, (long)text
.c_str());
1108 // Set to read only or read write.
1109 void wxStyledTextCtrl::SetReadOnly(bool readOnly
) {
1110 SendMsg(2171, readOnly
, 0);
1113 // Will a paste succeed?
1114 bool wxStyledTextCtrl::CanPaste() {
1115 return SendMsg(2173, 0, 0) != 0;
1118 // Are there any undoable actions in the undo history.
1119 bool wxStyledTextCtrl::CanUndo() {
1120 return SendMsg(2174, 0, 0) != 0;
1123 // Delete the undo history.
1124 void wxStyledTextCtrl::EmptyUndoBuffer() {
1125 SendMsg(2175, 0, 0);
1128 // Undo one action in the undo history.
1129 void wxStyledTextCtrl::Undo() {
1130 SendMsg(2176, 0, 0);
1133 // Cut the selection to the clipboard.
1134 void wxStyledTextCtrl::Cut() {
1135 SendMsg(2177, 0, 0);
1138 // Copy the selection to the clipboard.
1139 void wxStyledTextCtrl::Copy() {
1140 SendMsg(2178, 0, 0);
1143 // Paste the contents of the clipboard into the document replacing the selection.
1144 void wxStyledTextCtrl::Paste() {
1145 SendMsg(2179, 0, 0);
1148 // Clear the selection.
1149 void wxStyledTextCtrl::Clear() {
1150 SendMsg(2180, 0, 0);
1153 // Replace the contents of the document with the argument text.
1154 void wxStyledTextCtrl::SetText(const wxString
& text
) {
1155 SendMsg(2181, 0, (long)text
.c_str());
1158 // Retrieve all the text in the document.
1159 wxString
wxStyledTextCtrl::GetText() {
1161 int len
= GetTextLength();
1162 char* buff
= text
.GetWriteBuf(len
+1); // leave room for the null...
1164 SendMsg(2182, len
+1, (long)buff
);
1165 text
.UngetWriteBuf(len
);
1169 // Retrieve the number of characters in the document.
1170 int wxStyledTextCtrl::GetTextLength() {
1171 return SendMsg(2183, 0, 0);
1174 // Set to overtype (true) or insert mode
1175 void wxStyledTextCtrl::SetOvertype(bool overtype
) {
1176 SendMsg(2186, overtype
, 0);
1179 // Returns true if overtype mode is active otherwise false is returned.
1180 bool wxStyledTextCtrl::GetOvertype() {
1181 return SendMsg(2187, 0, 0) != 0;
1184 // Set the width of the insert mode caret
1185 void wxStyledTextCtrl::SetCaretWidth(int pixelWidth
) {
1186 SendMsg(2188, pixelWidth
, 0);
1189 // Returns the width of the insert mode caret
1190 int wxStyledTextCtrl::GetCaretWidth() {
1191 return SendMsg(2189, 0, 0);
1194 // Sets the position that starts the target which is used for updating the
1195 // document without affecting the scroll position.
1196 void wxStyledTextCtrl::SetTargetStart(int pos
) {
1197 SendMsg(2190, pos
, 0);
1200 // Get the position that starts the target.
1201 int wxStyledTextCtrl::GetTargetStart() {
1202 return SendMsg(2191, 0, 0);
1205 // Sets the position that ends the target which is used for updating the
1206 // document without affecting the scroll position.
1207 void wxStyledTextCtrl::SetTargetEnd(int pos
) {
1208 SendMsg(2192, pos
, 0);
1211 // Get the position that ends the target.
1212 int wxStyledTextCtrl::GetTargetEnd() {
1213 return SendMsg(2193, 0, 0);
1216 // Replace the target text with the argument text.
1217 // Text is counted so it can contain nulls.
1218 // Returns the length of the replacement text.
1220 int wxStyledTextCtrl::ReplaceTarget(const wxString
& text
) {
1221 return SendMsg(2194, text
.Len(), (long)text
.c_str());
1225 // Replace the target text with the argument text after \d processing.
1226 // Text is counted so it can contain nulls.
1227 // Looks for \d where d is between 1 and 9 and replaces these with the strings
1228 // matched in the last search operation which were surrounded by \( and \).
1229 // Returns the length of the replacement text including any change
1230 // caused by processing the \d patterns.
1232 int wxStyledTextCtrl::ReplaceTargetRE(const wxString
& text
) {
1233 return SendMsg(2195, text
.Len(), (long)text
.c_str());
1237 // Search for a counted string in the target and set the target to the found
1238 // range. Text is counted so it can contain nulls.
1239 // Returns length of range or -1 for failure in which case target is not moved.
1241 int wxStyledTextCtrl::SearchInTarget(const wxString
& text
) {
1242 return SendMsg(2197, text
.Len(), (long)text
.c_str());
1246 // Set the search flags used by SearchInTarget
1247 void wxStyledTextCtrl::SetSearchFlags(int flags
) {
1248 SendMsg(2198, flags
, 0);
1251 // Get the search flags used by SearchInTarget
1252 int wxStyledTextCtrl::GetSearchFlags() {
1253 return SendMsg(2199, 0, 0);
1256 // Show a call tip containing a definition near position pos.
1257 void wxStyledTextCtrl::CallTipShow(int pos
, const wxString
& definition
) {
1258 SendMsg(2200, pos
, (long)definition
.c_str());
1261 // Remove the call tip from the screen.
1262 void wxStyledTextCtrl::CallTipCancel() {
1263 SendMsg(2201, 0, 0);
1266 // Is there an active call tip?
1267 bool wxStyledTextCtrl::CallTipActive() {
1268 return SendMsg(2202, 0, 0) != 0;
1271 // Retrieve the position where the caret was before displaying the call tip.
1272 int wxStyledTextCtrl::CallTipPosAtStart() {
1273 return SendMsg(2203, 0, 0);
1276 // Highlight a segment of the definition.
1277 void wxStyledTextCtrl::CallTipSetHighlight(int start
, int end
) {
1278 SendMsg(2204, start
, end
);
1281 // Set the background colour for the call tip.
1282 void wxStyledTextCtrl::CallTipSetBackground(const wxColour
& back
) {
1283 SendMsg(2205, wxColourAsLong(back
), 0);
1286 // Find the display line of a document line taking hidden lines into account.
1287 int wxStyledTextCtrl::VisibleFromDocLine(int line
) {
1288 return SendMsg(2220, line
, 0);
1291 // Find the document line of a display line taking hidden lines into account.
1292 int wxStyledTextCtrl::DocLineFromVisible(int lineDisplay
) {
1293 return SendMsg(2221, lineDisplay
, 0);
1296 // Set the fold level of a line.
1297 // This encodes an integer level along with flags indicating whether the
1298 // line is a header and whether it is effectively white space.
1299 void wxStyledTextCtrl::SetFoldLevel(int line
, int level
) {
1300 SendMsg(2222, line
, level
);
1303 // Retrieve the fold level of a line.
1304 int wxStyledTextCtrl::GetFoldLevel(int line
) {
1305 return SendMsg(2223, line
, 0);
1308 // Find the last child line of a header line.
1309 int wxStyledTextCtrl::GetLastChild(int line
, int level
) {
1310 return SendMsg(2224, line
, level
);
1313 // Find the parent line of a child line.
1314 int wxStyledTextCtrl::GetFoldParent(int line
) {
1315 return SendMsg(2225, line
, 0);
1318 // Make a range of lines visible.
1319 void wxStyledTextCtrl::ShowLines(int lineStart
, int lineEnd
) {
1320 SendMsg(2226, lineStart
, lineEnd
);
1323 // Make a range of lines invisible.
1324 void wxStyledTextCtrl::HideLines(int lineStart
, int lineEnd
) {
1325 SendMsg(2227, lineStart
, lineEnd
);
1328 // Is a line visible?
1329 bool wxStyledTextCtrl::GetLineVisible(int line
) {
1330 return SendMsg(2228, line
, 0) != 0;
1333 // Show the children of a header line.
1334 void wxStyledTextCtrl::SetFoldExpanded(int line
, bool expanded
) {
1335 SendMsg(2229, line
, expanded
);
1338 // Is a header line expanded?
1339 bool wxStyledTextCtrl::GetFoldExpanded(int line
) {
1340 return SendMsg(2230, line
, 0) != 0;
1343 // Switch a header line between expanded and contracted.
1344 void wxStyledTextCtrl::ToggleFold(int line
) {
1345 SendMsg(2231, line
, 0);
1348 // Ensure a particular line is visible by expanding any header line hiding it.
1349 void wxStyledTextCtrl::EnsureVisible(int line
) {
1350 SendMsg(2232, line
, 0);
1353 // Set some debugging options for folding
1354 void wxStyledTextCtrl::SetFoldFlags(int flags
) {
1355 SendMsg(2233, flags
, 0);
1358 // Ensure a particular line is visible by expanding any header line hiding it.
1359 // Use the currently set visibility policy to determine which range to display.
1360 void wxStyledTextCtrl::EnsureVisibleEnforcePolicy(int line
) {
1361 SendMsg(2234, line
, 0);
1364 // Sets whether a tab pressed when caret is within indentation indents
1365 void wxStyledTextCtrl::SetTabIndents(bool tabIndents
) {
1366 SendMsg(2260, tabIndents
, 0);
1369 // Does a tab pressed when caret is within indentation indent?
1370 bool wxStyledTextCtrl::GetTabIndents() {
1371 return SendMsg(2261, 0, 0) != 0;
1374 // Sets whether a backspace pressed when caret is within indentation unindents
1375 void wxStyledTextCtrl::SetBackSpaceUnIndents(bool bsUnIndents
) {
1376 SendMsg(2262, bsUnIndents
, 0);
1379 // Does a backspace pressed when caret is within indentation unindent?
1380 bool wxStyledTextCtrl::GetBackSpaceUnIndents() {
1381 return SendMsg(2263, 0, 0) != 0;
1384 // Sets the time the mouse must sit still to generate a mouse dwell event
1385 void wxStyledTextCtrl::SetMouseDwellTime(int periodMilliseconds
) {
1386 SendMsg(2264, periodMilliseconds
, 0);
1389 // Retrieve the time the mouse must sit still to generate a mouse dwell event
1390 int wxStyledTextCtrl::GetMouseDwellTime() {
1391 return SendMsg(2265, 0, 0);
1394 // Move the caret inside current view if it's not there already
1395 void wxStyledTextCtrl::MoveCaretInsideView() {
1396 SendMsg(2401, 0, 0);
1399 // How many characters are on a line, not including end of line characters.
1400 int wxStyledTextCtrl::LineLength(int line
) {
1401 return SendMsg(2350, line
, 0);
1404 // Highlight the characters at two positions.
1405 void wxStyledTextCtrl::BraceHighlight(int pos1
, int pos2
) {
1406 SendMsg(2351, pos1
, pos2
);
1409 // Highlight the character at a position indicating there is no matching brace.
1410 void wxStyledTextCtrl::BraceBadLight(int pos
) {
1411 SendMsg(2352, pos
, 0);
1414 // Find the position of a matching brace or INVALID_POSITION if no match.
1415 int wxStyledTextCtrl::BraceMatch(int pos
) {
1416 return SendMsg(2353, pos
, 0);
1419 // Are the end of line characters visible.
1420 bool wxStyledTextCtrl::GetViewEOL() {
1421 return SendMsg(2355, 0, 0) != 0;
1424 // Make the end of line characters visible or invisible
1425 void wxStyledTextCtrl::SetViewEOL(bool visible
) {
1426 SendMsg(2356, visible
, 0);
1429 // Retrieve a pointer to the document object.
1430 void* wxStyledTextCtrl::GetDocPointer() {
1431 return (void*)SendMsg(2357);
1434 // Change the document object used.
1435 void wxStyledTextCtrl::SetDocPointer(void* docPointer
) {
1436 SendMsg(2358, 0, (long)docPointer
);
1439 // Set which document modification events are sent to the container.
1440 void wxStyledTextCtrl::SetModEventMask(int mask
) {
1441 SendMsg(2359, mask
, 0);
1444 // Retrieve the column number which text should be kept within.
1445 int wxStyledTextCtrl::GetEdgeColumn() {
1446 return SendMsg(2360, 0, 0);
1449 // Set the column number of the edge.
1450 // If text goes past the edge then it is highlighted.
1451 void wxStyledTextCtrl::SetEdgeColumn(int column
) {
1452 SendMsg(2361, column
, 0);
1455 // Retrieve the edge highlight mode.
1456 int wxStyledTextCtrl::GetEdgeMode() {
1457 return SendMsg(2362, 0, 0);
1460 // The edge may be displayed by a line (EDGE_LINE) or by highlighting text that
1461 // goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
1462 void wxStyledTextCtrl::SetEdgeMode(int mode
) {
1463 SendMsg(2363, mode
, 0);
1466 // Retrieve the colour used in edge indication.
1467 wxColour
wxStyledTextCtrl::GetEdgeColour() {
1468 long c
= SendMsg(2364, 0, 0);
1469 return wxColourFromLong(c
);
1472 // Change the colour used in edge indication.
1473 void wxStyledTextCtrl::SetEdgeColour(const wxColour
& edgeColour
) {
1474 SendMsg(2365, wxColourAsLong(edgeColour
), 0);
1477 // Sets the current caret position to be the search anchor.
1478 void wxStyledTextCtrl::SearchAnchor() {
1479 SendMsg(2366, 0, 0);
1482 // Find some text starting at the search anchor.
1483 // Does not ensure the selection is visible.
1484 int wxStyledTextCtrl::SearchNext(int flags
, const wxString
& text
) {
1485 return SendMsg(2367, flags
, (long)text
.c_str());
1488 // Find some text starting at the search anchor and moving backwards.
1489 // Does not ensure the selection is visible.
1490 int wxStyledTextCtrl::SearchPrev(int flags
, const wxString
& text
) {
1491 return SendMsg(2368, flags
, (long)text
.c_str());
1494 // Set the way the line the caret is on is kept visible.
1495 void wxStyledTextCtrl::SetCaretPolicy(int caretPolicy
, int caretSlop
) {
1496 SendMsg(2369, caretPolicy
, caretSlop
);
1499 // Retrieves the number of lines completely visible.
1500 int wxStyledTextCtrl::LinesOnScreen() {
1501 return SendMsg(2370, 0, 0);
1504 // Set whether a pop up menu is displayed automatically when the user presses
1505 // the wrong mouse button.
1506 void wxStyledTextCtrl::UsePopUp(bool allowPopUp
) {
1507 SendMsg(2371, allowPopUp
, 0);
1510 // Is the selection a rectangular. The alternative is the more common stream selection.
1511 bool wxStyledTextCtrl::SelectionIsRectangle() {
1512 return SendMsg(2372, 0, 0) != 0;
1515 // Set the zoom level. This number of points is added to the size of all fonts.
1516 // It may be positive to magnify or negative to reduce.
1517 void wxStyledTextCtrl::SetZoom(int zoom
) {
1518 SendMsg(2373, zoom
, 0);
1521 // Retrieve the zoom level.
1522 int wxStyledTextCtrl::GetZoom() {
1523 return SendMsg(2374, 0, 0);
1526 // Create a new document object.
1527 // Starts with reference count of 1 and not selected into editor.
1528 void* wxStyledTextCtrl::CreateDocument() {
1529 return (void*)SendMsg(2375);
1532 // Extend life of document.
1533 void wxStyledTextCtrl::AddRefDocument(void* docPointer
) {
1534 SendMsg(2376, (long)docPointer
);
1537 // Release a reference to the document, deleting document if it fades to black.
1538 void wxStyledTextCtrl::ReleaseDocument(void* docPointer
) {
1539 SendMsg(2377, (long)docPointer
);
1542 // Get which document modification events are sent to the container.
1543 int wxStyledTextCtrl::GetModEventMask() {
1544 return SendMsg(2378, 0, 0);
1547 // Change internal focus flag
1548 void wxStyledTextCtrl::SetSTCFocus(bool focus
) {
1549 SendMsg(2380, focus
, 0);
1552 // Get internal focus flag
1553 bool wxStyledTextCtrl::GetSTCFocus() {
1554 return SendMsg(2381, 0, 0) != 0;
1557 // Change error status - 0 = OK
1558 void wxStyledTextCtrl::SetStatus(int statusCode
) {
1559 SendMsg(2382, statusCode
, 0);
1563 int wxStyledTextCtrl::GetStatus() {
1564 return SendMsg(2383, 0, 0);
1567 // Set whether the mouse is captured when its button is pressed
1568 void wxStyledTextCtrl::SetMouseDownCaptures(bool captures
) {
1569 SendMsg(2384, captures
, 0);
1572 // Get whether mouse gets captured
1573 bool wxStyledTextCtrl::GetMouseDownCaptures() {
1574 return SendMsg(2385, 0, 0) != 0;
1577 // Sets the cursor to one of the SC_CURSOR* values
1578 void wxStyledTextCtrl::SetCursor(int cursorType
) {
1579 SendMsg(2386, cursorType
, 0);
1583 int wxStyledTextCtrl::GetCursor() {
1584 return SendMsg(2387, 0, 0);
1587 // Move to the previous change in capitalistion
1588 void wxStyledTextCtrl::WordPartLeft() {
1589 SendMsg(2390, 0, 0);
1592 // Move to the previous change in capitalistion extending selection to new caret position.
1593 void wxStyledTextCtrl::WordPartLeftExtend() {
1594 SendMsg(2391, 0, 0);
1597 // Move to the change next in capitalistion
1598 void wxStyledTextCtrl::WordPartRight() {
1599 SendMsg(2392, 0, 0);
1602 // Move to the next change in capitalistion extending selection to new caret position.
1603 void wxStyledTextCtrl::WordPartRightExtend() {
1604 SendMsg(2393, 0, 0);
1607 // Set the way the display area is determined when a particular line is to be moved to.
1608 void wxStyledTextCtrl::SetVisiblePolicy(int visiblePolicy
, int visibleSlop
) {
1609 SendMsg(2394, visiblePolicy
, visibleSlop
);
1612 // Delete back from the current position to the start of the line
1613 void wxStyledTextCtrl::DelLineLeft() {
1614 SendMsg(2395, 0, 0);
1617 // Delete forwards from the current position to the end of the line
1618 void wxStyledTextCtrl::DelLineRight() {
1619 SendMsg(2396, 0, 0);
1622 // Start notifying the container of all key presses and commands.
1623 void wxStyledTextCtrl::StartRecord() {
1624 SendMsg(3001, 0, 0);
1627 // Stop notifying the container of all key presses and commands.
1628 void wxStyledTextCtrl::StopRecord() {
1629 SendMsg(3002, 0, 0);
1632 // Set the lexing language of the document.
1633 void wxStyledTextCtrl::SetLexer(int lexer
) {
1634 SendMsg(4001, lexer
, 0);
1637 // Retrieve the lexing language of the document.
1638 int wxStyledTextCtrl::GetLexer() {
1639 return SendMsg(4002, 0, 0);
1642 // Colourise a segment of the document using the current lexing language.
1643 void wxStyledTextCtrl::Colourise(int start
, int end
) {
1644 SendMsg(4003, start
, end
);
1647 // Set up a value that may be used by a lexer for some optional feature.
1648 void wxStyledTextCtrl::SetProperty(const wxString
& key
, const wxString
& value
) {
1649 SendMsg(4004, (long)key
.c_str(), (long)value
.c_str());
1652 // Set up the key words used by the lexer.
1653 void wxStyledTextCtrl::SetKeyWords(int keywordSet
, const wxString
& keyWords
) {
1654 SendMsg(4005, keywordSet
, (long)keyWords
.c_str());
1657 // Set the lexing language of the document based on string name.
1658 void wxStyledTextCtrl::SetLexerLanguage(const wxString
& language
) {
1659 SendMsg(4006, 0, (long)language
.c_str());
1662 // END of generated section
1663 //----------------------------------------------------------------------
1666 // Returns the line number of the line with the caret.
1667 int wxStyledTextCtrl::GetCurrentLine() {
1668 int line
= LineFromPosition(GetCurrentPos());
1673 // Extract style settings from a spec-string which is composed of one or
1674 // more of the following comma separated elements:
1676 // bold turns on bold
1677 // italic turns on italics
1678 // fore:#RRGGBB sets the foreground colour
1679 // back:#RRGGBB sets the background colour
1680 // face:[facename] sets the font face name to use
1681 // size:[num] sets the font size in points
1682 // eol turns on eol filling
1683 // underline turns on underlining
1685 void wxStyledTextCtrl::StyleSetSpec(int styleNum
, const wxString
& spec
) {
1687 wxStringTokenizer
tkz(spec
, ",");
1688 while (tkz
.HasMoreTokens()) {
1689 wxString token
= tkz
.GetNextToken();
1691 wxString option
= token
.BeforeFirst(':');
1692 wxString val
= token
.AfterFirst(':');
1694 if (option
== "bold")
1695 StyleSetBold(styleNum
, true);
1697 else if (option
== "italic")
1698 StyleSetItalic(styleNum
, true);
1700 else if (option
== "underline")
1701 StyleSetUnderline(styleNum
, true);
1703 else if (option
== "eol")
1704 StyleSetEOLFilled(styleNum
, true);
1706 else if (option
== "size") {
1708 if (val
.ToLong(&points
))
1709 StyleSetSize(styleNum
, points
);
1712 else if (option
== "face")
1713 StyleSetFaceName(styleNum
, val
);
1715 else if (option
== "fore")
1716 StyleSetForeground(styleNum
, wxColourFromSpec(val
));
1718 else if (option
== "back")
1719 StyleSetBackground(styleNum
, wxColourFromSpec(val
));
1724 // Set style size, face, bold, italic, and underline attributes from
1725 // a wxFont's attributes.
1726 void wxStyledTextCtrl::StyleSetFont(int styleNum
, wxFont
& font
) {
1727 int size
= font
.GetPointSize();
1728 wxString faceName
= font
.GetFaceName();
1729 bool bold
= font
.GetWeight() == wxBOLD
;
1730 bool italic
= font
.GetStyle() != wxNORMAL
;
1731 bool under
= font
.GetUnderlined();
1733 // TODO: add encoding/charset mapping
1734 StyleSetFontAttr(styleNum
, size
, faceName
, bold
, italic
, under
);
1737 // Set all font style attributes at once.
1738 void wxStyledTextCtrl::StyleSetFontAttr(int styleNum
, int size
,
1739 const wxString
& faceName
,
1740 bool bold
, bool italic
,
1742 StyleSetSize(styleNum
, size
);
1743 StyleSetFaceName(styleNum
, faceName
);
1744 StyleSetBold(styleNum
, bold
);
1745 StyleSetItalic(styleNum
, italic
);
1746 StyleSetUnderline(styleNum
, underline
);
1748 // TODO: add encoding/charset mapping
1752 // Perform one of the operations defined by the wxSTC_CMD_* constants.
1753 void wxStyledTextCtrl::CmdKeyExecute(int cmd
) {
1758 // Set the left and right margin in the edit area, measured in pixels.
1759 void wxStyledTextCtrl::SetMargins(int left
, int right
) {
1760 SetMarginLeft(left
);
1761 SetMarginRight(right
);
1765 // Retrieve the start and end positions of the current selection.
1766 void wxStyledTextCtrl::GetSelection(int* startPos
, int* endPos
) {
1767 if (startPos
!= NULL
)
1768 *startPos
= SendMsg(SCI_GETSELECTIONSTART
);
1770 *endPos
= SendMsg(SCI_GETSELECTIONEND
);
1774 // Retrieve the point in the window where a position is displayed.
1775 wxPoint
wxStyledTextCtrl::PointFromPosition(int pos
) {
1776 int x
= SendMsg(SCI_POINTXFROMPOSITION
, 0, pos
);
1777 int y
= SendMsg(SCI_POINTYFROMPOSITION
, 0, pos
);
1778 return wxPoint(x
, y
);
1781 // Scroll enough to make the given line visible
1782 void wxStyledTextCtrl::ScrollToLine(int line
) {
1783 m_swx
->DoScrollToLine(line
);
1787 // Scroll enough to make the given column visible
1788 void wxStyledTextCtrl::ScrollToColumn(int column
) {
1789 m_swx
->DoScrollToColumn(column
);
1794 //----------------------------------------------------------------------
1797 void wxStyledTextCtrl::OnPaint(wxPaintEvent
& evt
) {
1799 wxRegion region
= GetUpdateRegion();
1801 m_swx
->DoPaint(&dc
, region
.GetBox());
1804 void wxStyledTextCtrl::OnScrollWin(wxScrollWinEvent
& evt
) {
1805 if (evt
.GetOrientation() == wxHORIZONTAL
)
1806 m_swx
->DoHScroll(evt
.GetEventType(), evt
.GetPosition());
1808 m_swx
->DoVScroll(evt
.GetEventType(), evt
.GetPosition());
1811 void wxStyledTextCtrl::OnScroll(wxScrollEvent
& evt
) {
1812 wxScrollBar
* sb
= wxDynamicCast(evt
.GetEventObject(), wxScrollBar
);
1814 if (sb
->IsVertical())
1815 m_swx
->DoVScroll(evt
.GetEventType(), evt
.GetPosition());
1817 m_swx
->DoHScroll(evt
.GetEventType(), evt
.GetPosition());
1821 void wxStyledTextCtrl::OnSize(wxSizeEvent
& evt
) {
1822 wxSize sz
= GetClientSize();
1823 m_swx
->DoSize(sz
.x
, sz
.y
);
1826 void wxStyledTextCtrl::OnMouseLeftDown(wxMouseEvent
& evt
) {
1827 wxPoint pt
= evt
.GetPosition();
1828 m_swx
->DoButtonDown(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
1829 evt
.ShiftDown(), evt
.ControlDown(), evt
.AltDown());
1832 void wxStyledTextCtrl::OnMouseMove(wxMouseEvent
& evt
) {
1833 wxPoint pt
= evt
.GetPosition();
1834 m_swx
->DoButtonMove(Point(pt
.x
, pt
.y
));
1837 void wxStyledTextCtrl::OnMouseLeftUp(wxMouseEvent
& evt
) {
1838 wxPoint pt
= evt
.GetPosition();
1839 m_swx
->DoButtonUp(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
1844 void wxStyledTextCtrl::OnMouseRightUp(wxMouseEvent
& evt
) {
1845 wxPoint pt
= evt
.GetPosition();
1846 m_swx
->DoContextMenu(Point(pt
.x
, pt
.y
));
1850 void wxStyledTextCtrl::OnContextMenu(wxContextMenuEvent
& evt
) {
1851 wxPoint pt
= evt
.GetPosition();
1852 ScreenToClient(&pt
.x
, &pt
.y
);
1853 m_swx
->DoContextMenu(Point(pt
.x
, pt
.y
));
1857 void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent
& evt
) {
1858 m_swx
->DoMouseWheel(evt
.GetWheelRotation(),
1859 evt
.GetWheelDelta(),
1860 evt
.GetLinesPerAction(),
1865 void wxStyledTextCtrl::OnChar(wxKeyEvent
& evt
) {
1866 long key
= evt
.KeyCode();
1868 // printf("OnChar key:%d consumed:%d ctrl:%d alt:%d\n",
1869 // key, m_lastKeyDownConsumed, evt.ControlDown(), evt.AltDown());
1872 // \|@#¬[]{}?£$~ ã,õ,Ã,Õ, ñ, Ñ
1874 // On (some?) non-US keyboards the AltGr key is required to enter some
1875 // common characters. It comes to us as both Alt and Ctrl down so we need
1876 // to let the char through in that case, otherwise if only ctrl or only
1877 // alt let's skip it.
1878 bool ctrl
= evt
.ControlDown();
1879 bool alt
= evt
.AltDown();
1880 bool skip
= ((ctrl
|| alt
) && ! (ctrl
&& alt
));
1882 if (key
<= 0xff && key
>= 32 && !m_lastKeyDownConsumed
&& !skip
) {
1883 m_swx
->DoAddChar(key
);
1890 void wxStyledTextCtrl::OnKeyDown(wxKeyEvent
& evt
) {
1891 long key
= evt
.KeyCode();
1892 bool shift
= evt
.ShiftDown(),
1893 ctrl
= evt
.ControlDown(),
1894 alt
= evt
.AltDown();
1896 int processed
= m_swx
->DoKeyDown(key
, shift
, ctrl
, alt
, &m_lastKeyDownConsumed
);
1898 // printf("key: %d shift: %d ctrl: %d alt: %d processed: %d consumed: %d\n",
1899 // key, shift, ctrl, alt, processed, m_lastKeyDownConsumed);
1901 if (!processed
&& !m_lastKeyDownConsumed
)
1906 void wxStyledTextCtrl::OnLoseFocus(wxFocusEvent
& evt
) {
1907 m_swx
->DoLoseFocus();
1911 void wxStyledTextCtrl::OnGainFocus(wxFocusEvent
& evt
) {
1912 m_swx
->DoGainFocus();
1916 void wxStyledTextCtrl::OnSysColourChanged(wxSysColourChangedEvent
& evt
) {
1917 m_swx
->DoSysColourChange();
1921 void wxStyledTextCtrl::OnEraseBackground(wxEraseEvent
& evt
) {
1922 // do nothing to help avoid flashing
1927 void wxStyledTextCtrl::OnMenu(wxCommandEvent
& evt
) {
1928 m_swx
->DoCommand(evt
.GetId());
1932 void wxStyledTextCtrl::OnListBox(wxCommandEvent
& evt
) {
1933 m_swx
->DoOnListBox();
1937 //----------------------------------------------------------------------
1938 // Turn notifications from Scintilla into events
1941 void wxStyledTextCtrl::NotifyChange() {
1942 wxStyledTextEvent
evt(wxEVT_STC_CHANGE
, GetId());
1943 evt
.SetEventObject(this);
1944 GetEventHandler()->ProcessEvent(evt
);
1947 void wxStyledTextCtrl::NotifyParent(SCNotification
* _scn
) {
1948 SCNotification
& scn
= *_scn
;
1949 wxStyledTextEvent
evt(0, GetId());
1951 evt
.SetEventObject(this);
1952 evt
.SetPosition(scn
.position
);
1954 evt
.SetModifiers(scn
.modifiers
);
1956 switch (scn
.nmhdr
.code
) {
1957 case SCN_STYLENEEDED
:
1958 evt
.SetEventType(wxEVT_STC_STYLENEEDED
);
1962 evt
.SetEventType(wxEVT_STC_CHARADDED
);
1965 case SCN_SAVEPOINTREACHED
:
1966 evt
.SetEventType(wxEVT_STC_SAVEPOINTREACHED
);
1969 case SCN_SAVEPOINTLEFT
:
1970 evt
.SetEventType(wxEVT_STC_SAVEPOINTLEFT
);
1973 case SCN_MODIFYATTEMPTRO
:
1974 evt
.SetEventType(wxEVT_STC_ROMODIFYATTEMPT
);
1978 evt
.SetEventType(wxEVT_STC_KEY
);
1981 case SCN_DOUBLECLICK
:
1982 evt
.SetEventType(wxEVT_STC_DOUBLECLICK
);
1986 evt
.SetEventType(wxEVT_STC_UPDATEUI
);
1990 evt
.SetEventType(wxEVT_STC_MODIFIED
);
1991 evt
.SetModificationType(scn
.modificationType
);
1993 evt
.SetText(wxString(scn
.text
, scn
.length
));
1994 evt
.SetLength(scn
.length
);
1995 evt
.SetLinesAdded(scn
.linesAdded
);
1996 evt
.SetLine(scn
.line
);
1997 evt
.SetFoldLevelNow(scn
.foldLevelNow
);
1998 evt
.SetFoldLevelPrev(scn
.foldLevelPrev
);
2001 case SCN_MACRORECORD
:
2002 evt
.SetEventType(wxEVT_STC_MACRORECORD
);
2003 evt
.SetMessage(scn
.message
);
2004 evt
.SetWParam(scn
.wParam
);
2005 evt
.SetLParam(scn
.lParam
);
2008 case SCN_MARGINCLICK
:
2009 evt
.SetEventType(wxEVT_STC_MARGINCLICK
);
2010 evt
.SetMargin(scn
.margin
);
2014 evt
.SetEventType(wxEVT_STC_NEEDSHOWN
);
2015 evt
.SetLength(scn
.length
);
2018 case SCN_POSCHANGED
:
2019 evt
.SetEventType(wxEVT_STC_POSCHANGED
);
2023 evt
.SetEventType(wxEVT_STC_PAINTED
);
2026 case SCN_USERLISTSELECTION
:
2027 evt
.SetEventType(wxEVT_STC_USERLISTSELECTION
);
2028 evt
.SetListType(scn
.listType
);
2029 evt
.SetText(scn
.text
);
2032 case SCN_URIDROPPED
:
2033 evt
.SetEventType(wxEVT_STC_URIDROPPED
);
2034 evt
.SetText(scn
.text
);
2037 case SCN_DWELLSTART
:
2038 evt
.SetEventType(wxEVT_STC_DWELLSTART
);
2044 evt
.SetEventType(wxEVT_STC_DWELLEND
);
2053 GetEventHandler()->ProcessEvent(evt
);
2057 //----------------------------------------------------------------------
2058 //----------------------------------------------------------------------
2059 //----------------------------------------------------------------------
2061 wxStyledTextEvent::wxStyledTextEvent(wxEventType commandType
, int id
)
2062 : wxCommandEvent(commandType
, id
)
2067 m_modificationType
= 0;
2072 m_foldLevelPrev
= 0;
2080 #if wxUSE_DRAG_AND_DROP
2081 m_dragAllowMove
= FALSE
;
2082 m_dragResult
= wxDragNone
;
2086 bool wxStyledTextEvent::GetShift() const { return (m_modifiers
& SCI_SHIFT
) != 0; }
2087 bool wxStyledTextEvent::GetControl() const { return (m_modifiers
& SCI_CTRL
) != 0; }
2088 bool wxStyledTextEvent::GetAlt() const { return (m_modifiers
& SCI_ALT
) != 0; }
2091 wxStyledTextEvent::wxStyledTextEvent(const wxStyledTextEvent
& event
):
2092 wxCommandEvent(event
)
2094 m_position
= event
.m_position
;
2095 m_key
= event
.m_key
;
2096 m_modifiers
= event
.m_modifiers
;
2097 m_modificationType
= event
.m_modificationType
;
2098 m_text
= event
.m_text
;
2099 m_length
= event
.m_length
;
2100 m_linesAdded
= event
.m_linesAdded
;
2101 m_line
= event
.m_line
;
2102 m_foldLevelNow
= event
.m_foldLevelNow
;
2103 m_foldLevelPrev
= event
.m_foldLevelPrev
;
2105 m_margin
= event
.m_margin
;
2107 m_message
= event
.m_message
;
2108 m_wParam
= event
.m_wParam
;
2109 m_lParam
= event
.m_lParam
;
2111 m_listType
= event
.m_listType
;
2115 #if wxUSE_DRAG_AND_DROP
2116 m_dragText
= event
.m_dragText
;
2117 m_dragAllowMove
=event
.m_dragAllowMove
;
2118 m_dragResult
= event
.m_dragResult
;
2122 //----------------------------------------------------------------------
2123 //----------------------------------------------------------------------