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 DEFINE_EVENT_TYPE( wxEVT_STC_START_DRAG
)
97 DEFINE_EVENT_TYPE( wxEVT_STC_DRAG_OVER
)
98 DEFINE_EVENT_TYPE( wxEVT_STC_DO_DROP
)
101 BEGIN_EVENT_TABLE(wxStyledTextCtrl
, wxControl
)
102 EVT_PAINT (wxStyledTextCtrl::OnPaint
)
103 EVT_SCROLLWIN (wxStyledTextCtrl::OnScrollWin
)
104 EVT_SCROLL (wxStyledTextCtrl::OnScroll
)
105 EVT_SIZE (wxStyledTextCtrl::OnSize
)
106 EVT_LEFT_DOWN (wxStyledTextCtrl::OnMouseLeftDown
)
108 // Let Scintilla see the double click as a second click
109 EVT_LEFT_DCLICK (wxStyledTextCtrl::OnMouseLeftDown
)
111 EVT_MOTION (wxStyledTextCtrl::OnMouseMove
)
112 EVT_LEFT_UP (wxStyledTextCtrl::OnMouseLeftUp
)
114 EVT_RIGHT_UP (wxStyledTextCtrl::OnMouseRightUp
)
116 EVT_CONTEXT_MENU (wxStyledTextCtrl::OnContextMenu
)
118 EVT_MOUSEWHEEL (wxStyledTextCtrl::OnMouseWheel
)
119 EVT_CHAR (wxStyledTextCtrl::OnChar
)
120 EVT_KEY_DOWN (wxStyledTextCtrl::OnKeyDown
)
121 EVT_KILL_FOCUS (wxStyledTextCtrl::OnLoseFocus
)
122 EVT_SET_FOCUS (wxStyledTextCtrl::OnGainFocus
)
123 EVT_SYS_COLOUR_CHANGED (wxStyledTextCtrl::OnSysColourChanged
)
124 EVT_ERASE_BACKGROUND (wxStyledTextCtrl::OnEraseBackground
)
125 EVT_MENU_RANGE (-1, -1, wxStyledTextCtrl::OnMenu
)
126 EVT_LISTBOX_DCLICK (-1, wxStyledTextCtrl::OnListBox
)
130 IMPLEMENT_CLASS(wxStyledTextCtrl
, wxControl
)
131 IMPLEMENT_DYNAMIC_CLASS(wxStyledTextEvent
, wxCommandEvent
)
133 //----------------------------------------------------------------------
134 // Constructor and Destructor
136 wxStyledTextCtrl::wxStyledTextCtrl(wxWindow
*parent
,
141 const wxString
& name
) :
142 wxControl(parent
, id
, pos
, size
,
143 style
| wxVSCROLL
| wxHSCROLL
| wxWANTS_CHARS
| wxCLIP_CHILDREN
,
144 wxDefaultValidator
, name
)
146 m_swx
= new ScintillaWX(this);
148 m_lastKeyDownConsumed
= FALSE
;
154 wxStyledTextCtrl::~wxStyledTextCtrl() {
159 //----------------------------------------------------------------------
161 long wxStyledTextCtrl::SendMsg(int msg
, long wp
, long lp
) {
163 return m_swx
->WndProc(msg
, wp
, lp
);
171 #define MAKELONG(a, b) ((a) | ((b) << 16))
174 static long wxColourAsLong(const wxColour
& co
) {
175 return (((long)co
.Blue() << 16) |
176 ((long)co
.Green() << 8) |
180 static wxColour
wxColourFromLong(long c
) {
182 clr
.Set(c
& 0xff, (c
>> 8) & 0xff, (c
>> 16) & 0xff);
187 static wxColour
wxColourFromSpec(const wxString
& spec
) {
188 // spec should be #RRGGBB
190 int red
= strtol(spec
.Mid(1,2), &junk
, 16);
191 int green
= strtol(spec
.Mid(3,2), &junk
, 16);
192 int blue
= strtol(spec
.Mid(5,2), &junk
, 16);
193 return wxColour(red
, green
, blue
);
197 //----------------------------------------------------------------------
198 // BEGIN generated section. The following code is automatically generated
199 // by gen_iface.py from the contents of Scintilla.iface. Do not edit
200 // this file. Edit stc.cpp.in or gen_iface.py instead and regenerate.
203 // Add text to the document
204 void wxStyledTextCtrl::AddText(const wxString
& text
) {
205 SendMsg(2001, text
.Len(), (long)text
.c_str());
208 // Add array of cells to document
209 void wxStyledTextCtrl::AddStyledText(const wxString
& text
) {
210 SendMsg(2002, text
.Len(), (long)text
.c_str());
213 // Insert string at a position
214 void wxStyledTextCtrl::InsertText(int pos
, const wxString
& text
) {
215 SendMsg(2003, pos
, (long)text
.c_str());
218 // Delete all text in the document
219 void wxStyledTextCtrl::ClearAll() {
223 // Set all style bytes to 0, remove all folding information
224 void wxStyledTextCtrl::ClearDocumentStyle() {
228 // The number of characters in the document
229 int wxStyledTextCtrl::GetLength() {
230 return SendMsg(2006, 0, 0);
233 // Returns the character byte at the position
234 int wxStyledTextCtrl::GetCharAt(int pos
) {
235 return SendMsg(2007, pos
, 0);
238 // Returns the position of the caret
239 int wxStyledTextCtrl::GetCurrentPos() {
240 return SendMsg(2008, 0, 0);
243 // Returns the position of the opposite end of the selection to the caret
244 int wxStyledTextCtrl::GetAnchor() {
245 return SendMsg(2009, 0, 0);
248 // Returns the style byte at the position
249 int wxStyledTextCtrl::GetStyleAt(int pos
) {
250 return SendMsg(2010, pos
, 0);
253 // Redoes the next action on the undo history
254 void wxStyledTextCtrl::Redo() {
258 // Choose between collecting actions into the undo
259 // history and discarding them.
260 void wxStyledTextCtrl::SetUndoCollection(bool collectUndo
) {
261 SendMsg(2012, collectUndo
, 0);
264 // Select all the text in the document.
265 void wxStyledTextCtrl::SelectAll() {
269 // Remember the current position in the undo history as the position
270 // at which the document was saved.
271 void wxStyledTextCtrl::SetSavePoint() {
275 // Retrieve a buffer of cells.
276 wxString
wxStyledTextCtrl::GetStyledText(int startPos
, int endPos
) {
278 int len
= endPos
- startPos
;
281 tr
.lpstrText
= text
.GetWriteBuf(len
*2);
282 tr
.chrg
.cpMin
= startPos
;
283 tr
.chrg
.cpMax
= endPos
;
284 SendMsg(2015, 0, (long)&tr
);
285 text
.UngetWriteBuf(len
*2);
289 // Are there any redoable actions in the undo history.
290 bool wxStyledTextCtrl::CanRedo() {
291 return SendMsg(2016, 0, 0) != 0;
294 // Retrieve the line number at which a particular marker is located
295 int wxStyledTextCtrl::MarkerLineFromHandle(int handle
) {
296 return SendMsg(2017, handle
, 0);
300 void wxStyledTextCtrl::MarkerDeleteHandle(int handle
) {
301 SendMsg(2018, handle
, 0);
304 // Is undo history being collected?
305 bool wxStyledTextCtrl::GetUndoCollection() {
306 return SendMsg(2019, 0, 0) != 0;
309 // Are white space characters currently visible?
310 // Returns one of SCWS_* constants.
311 int wxStyledTextCtrl::GetViewWhiteSpace() {
312 return SendMsg(2020, 0, 0);
315 // Make white space characters invisible, always visible or visible outside indentation.
316 void wxStyledTextCtrl::SetViewWhiteSpace(int viewWS
) {
317 SendMsg(2021, viewWS
, 0);
320 // Find the position from a point within the window.
321 int wxStyledTextCtrl::PositionFromPoint(wxPoint pt
) {
322 return SendMsg(2022, pt
.x
, pt
.y
);
325 // Find the position from a point within the window but return
326 // INVALID_POSITION if not close to text.
327 int wxStyledTextCtrl::PositionFromPointClose(int x
, int y
) {
328 return SendMsg(2023, x
, y
);
331 // Set caret to start of a line and ensure it is visible.
332 void wxStyledTextCtrl::GotoLine(int line
) {
333 SendMsg(2024, line
, 0);
336 // Set caret to a position and ensure it is visible.
337 void wxStyledTextCtrl::GotoPos(int pos
) {
338 SendMsg(2025, pos
, 0);
341 // Set the selection anchor to a position. The anchor is the opposite
342 // end of the selection from the caret.
343 void wxStyledTextCtrl::SetAnchor(int posAnchor
) {
344 SendMsg(2026, posAnchor
, 0);
347 // Retrieve the text of the line containing the caret.
348 // Returns the index of the caret on the line.
349 wxString
wxStyledTextCtrl::GetCurLine(int* linePos
) {
351 int len
= LineLength(GetCurrentLine());
353 if (linePos
) *linePos
= 0;
356 // Need an extra byte because SCI_GETCURLINE writes a null to the string
357 char* buf
= text
.GetWriteBuf(len
+1);
359 int pos
= SendMsg(2027, len
+1, (long)buf
);
360 text
.UngetWriteBuf(len
);
361 if (linePos
) *linePos
= pos
;
366 // Retrieve the position of the last correctly styled character.
367 int wxStyledTextCtrl::GetEndStyled() {
368 return SendMsg(2028, 0, 0);
371 // Convert all line endings in the document to one mode.
372 void wxStyledTextCtrl::ConvertEOLs(int eolMode
) {
373 SendMsg(2029, eolMode
, 0);
376 // Retrieve the current end of line mode - one of CRLF, CR, or LF.
377 int wxStyledTextCtrl::GetEOLMode() {
378 return SendMsg(2030, 0, 0);
381 // Set the current end of line mode.
382 void wxStyledTextCtrl::SetEOLMode(int eolMode
) {
383 SendMsg(2031, eolMode
, 0);
386 // Set the current styling position to pos and the styling mask to mask.
387 // The styling mask can be used to protect some bits in each styling byte from
389 void wxStyledTextCtrl::StartStyling(int pos
, int mask
) {
390 SendMsg(2032, pos
, mask
);
393 // Change style from current styling position for length characters to a style
394 // and move the current styling position to after this newly styled segment.
395 void wxStyledTextCtrl::SetStyling(int length
, int style
) {
396 SendMsg(2033, length
, style
);
399 // Is drawing done first into a buffer or direct to the screen.
400 bool wxStyledTextCtrl::GetBufferedDraw() {
401 return SendMsg(2034, 0, 0) != 0;
404 // If drawing is buffered then each line of text is drawn into a bitmap buffer
405 // before drawing it to the screen to avoid flicker.
406 void wxStyledTextCtrl::SetBufferedDraw(bool buffered
) {
407 SendMsg(2035, buffered
, 0);
410 // Change the visible size of a tab to be a multiple of the width of a space
412 void wxStyledTextCtrl::SetTabWidth(int tabWidth
) {
413 SendMsg(2036, tabWidth
, 0);
416 // Retrieve the visible size of a tab.
417 int wxStyledTextCtrl::GetTabWidth() {
418 return SendMsg(2121, 0, 0);
421 // Set the code page used to interpret the bytes of the document as characters.
422 // The SC_CP_UTF8 value can be used to enter Unicode mode.
423 void wxStyledTextCtrl::SetCodePage(int codePage
) {
424 SendMsg(2037, codePage
, 0);
427 // Set the symbol used for a particular marker number,
428 // and optionally the for and background colours.
429 void wxStyledTextCtrl::MarkerDefine(int markerNumber
, int markerSymbol
,
430 const wxColour
& foreground
,
431 const wxColour
& background
) {
433 SendMsg(2040, markerNumber
, markerSymbol
);
435 MarkerSetForeground(markerNumber
, foreground
);
437 MarkerSetBackground(markerNumber
, background
);
440 // Set the foreground colour used for a particular marker number.
441 void wxStyledTextCtrl::MarkerSetForeground(int markerNumber
, const wxColour
& fore
) {
442 SendMsg(2041, markerNumber
, wxColourAsLong(fore
));
445 // Set the background colour used for a particular marker number.
446 void wxStyledTextCtrl::MarkerSetBackground(int markerNumber
, const wxColour
& back
) {
447 SendMsg(2042, markerNumber
, wxColourAsLong(back
));
450 // Add a marker to a line.
451 void wxStyledTextCtrl::MarkerAdd(int line
, int markerNumber
) {
452 SendMsg(2043, line
, markerNumber
);
455 // Delete a marker from a line
456 void wxStyledTextCtrl::MarkerDelete(int line
, int markerNumber
) {
457 SendMsg(2044, line
, markerNumber
);
460 // Delete all markers with a particular number from all lines
461 void wxStyledTextCtrl::MarkerDeleteAll(int markerNumber
) {
462 SendMsg(2045, markerNumber
, 0);
465 // Get a bit mask of all the markers set on a line.
466 int wxStyledTextCtrl::MarkerGet(int line
) {
467 return SendMsg(2046, line
, 0);
470 // Find the next line after lineStart that includes a marker in mask.
471 int wxStyledTextCtrl::MarkerNext(int lineStart
, int markerMask
) {
472 return SendMsg(2047, lineStart
, markerMask
);
475 // Find the previous line before lineStart that includes a marker in mask.
476 int wxStyledTextCtrl::MarkerPrevious(int lineStart
, int markerMask
) {
477 return SendMsg(2048, lineStart
, markerMask
);
480 // Set a margin to be either numeric or symbolic.
481 void wxStyledTextCtrl::SetMarginType(int margin
, int marginType
) {
482 SendMsg(2240, margin
, marginType
);
485 // Retrieve the type of a margin.
486 int wxStyledTextCtrl::GetMarginType(int margin
) {
487 return SendMsg(2241, margin
, 0);
490 // Set the width of a margin to a width expressed in pixels.
491 void wxStyledTextCtrl::SetMarginWidth(int margin
, int pixelWidth
) {
492 SendMsg(2242, margin
, pixelWidth
);
495 // Retrieve the width of a margin in pixels.
496 int wxStyledTextCtrl::GetMarginWidth(int margin
) {
497 return SendMsg(2243, margin
, 0);
500 // Set a mask that determines which markers are displayed in a margin.
501 void wxStyledTextCtrl::SetMarginMask(int margin
, int mask
) {
502 SendMsg(2244, margin
, mask
);
505 // Retrieve the marker mask of a margin.
506 int wxStyledTextCtrl::GetMarginMask(int margin
) {
507 return SendMsg(2245, margin
, 0);
510 // Make a margin sensitive or insensitive to mouse clicks.
511 void wxStyledTextCtrl::SetMarginSensitive(int margin
, bool sensitive
) {
512 SendMsg(2246, margin
, sensitive
);
515 // Retrieve the mouse click sensitivity of a margin.
516 bool wxStyledTextCtrl::GetMarginSensitive(int margin
) {
517 return SendMsg(2247, margin
, 0) != 0;
520 // Clear all the styles and make equivalent to the global default style.
521 void wxStyledTextCtrl::StyleClearAll() {
525 // Set the foreground colour of a style.
526 void wxStyledTextCtrl::StyleSetForeground(int style
, const wxColour
& fore
) {
527 SendMsg(2051, style
, wxColourAsLong(fore
));
530 // Set the background colour of a style.
531 void wxStyledTextCtrl::StyleSetBackground(int style
, const wxColour
& back
) {
532 SendMsg(2052, style
, wxColourAsLong(back
));
535 // Set a style to be bold or not.
536 void wxStyledTextCtrl::StyleSetBold(int style
, bool bold
) {
537 SendMsg(2053, style
, bold
);
540 // Set a style to be italic or not.
541 void wxStyledTextCtrl::StyleSetItalic(int style
, bool italic
) {
542 SendMsg(2054, style
, italic
);
545 // Set the size of characters of a style.
546 void wxStyledTextCtrl::StyleSetSize(int style
, int sizePoints
) {
547 SendMsg(2055, style
, sizePoints
);
550 // Set the font of a style.
551 void wxStyledTextCtrl::StyleSetFaceName(int style
, const wxString
& fontName
) {
552 SendMsg(2056, style
, (long)fontName
.c_str());
555 // Set a style to have its end of line filled or not.
556 void wxStyledTextCtrl::StyleSetEOLFilled(int style
, bool filled
) {
557 SendMsg(2057, style
, filled
);
560 // Reset the default style to its state at startup
561 void wxStyledTextCtrl::StyleResetDefault() {
565 // Set a style to be underlined or not.
566 void wxStyledTextCtrl::StyleSetUnderline(int style
, bool underline
) {
567 SendMsg(2059, style
, underline
);
570 // Set a style to be mixed case, or to force upper or lower case.
571 void wxStyledTextCtrl::StyleSetCase(int style
, int caseForce
) {
572 SendMsg(2060, style
, caseForce
);
575 // Set the foreground colour of the selection and whether to use this setting.
576 void wxStyledTextCtrl::SetSelForeground(bool useSetting
, const wxColour
& fore
) {
577 SendMsg(2067, useSetting
, wxColourAsLong(fore
));
580 // Set the background colour of the selection and whether to use this setting.
581 void wxStyledTextCtrl::SetSelBackground(bool useSetting
, const wxColour
& back
) {
582 SendMsg(2068, useSetting
, wxColourAsLong(back
));
585 // Set the foreground colour of the caret.
586 void wxStyledTextCtrl::SetCaretForeground(const wxColour
& fore
) {
587 SendMsg(2069, wxColourAsLong(fore
), 0);
590 // When key+modifier combination km is pressed perform msg.
591 void wxStyledTextCtrl::CmdKeyAssign(int key
, int modifiers
, int cmd
) {
592 SendMsg(2070, MAKELONG(key
, modifiers
), cmd
);
595 // When key+modifier combination km do nothing.
596 void wxStyledTextCtrl::CmdKeyClear(int key
, int modifiers
) {
597 SendMsg(2071, MAKELONG(key
, modifiers
));
600 // Drop all key mappings.
601 void wxStyledTextCtrl::CmdKeyClearAll() {
605 // Set the styles for a segment of the document.
606 void wxStyledTextCtrl::SetStyleBytes(int length
, char* styleBytes
) {
607 SendMsg(2073, length
, (long)styleBytes
);
610 // Set a style to be visible or not.
611 void wxStyledTextCtrl::StyleSetVisible(int style
, bool visible
) {
612 SendMsg(2074, style
, visible
);
615 // Get the time in milliseconds that the caret is on and off.
616 int wxStyledTextCtrl::GetCaretPeriod() {
617 return SendMsg(2075, 0, 0);
620 // Get the time in milliseconds that the caret is on and off. 0 = steady on.
621 void wxStyledTextCtrl::SetCaretPeriod(int periodMilliseconds
) {
622 SendMsg(2076, periodMilliseconds
, 0);
625 // Set the set of characters making up words for when moving or selecting
627 void wxStyledTextCtrl::SetWordChars(const wxString
& characters
) {
628 SendMsg(2077, 0, (long)characters
.c_str());
631 // Start a sequence of actions that is undone and redone as a unit.
633 void wxStyledTextCtrl::BeginUndoAction() {
637 // End a sequence of actions that is undone and redone as a unit.
638 void wxStyledTextCtrl::EndUndoAction() {
642 // Set an indicator to plain, squiggle or TT.
643 void wxStyledTextCtrl::IndicatorSetStyle(int indic
, int style
) {
644 SendMsg(2080, indic
, style
);
647 // Retrieve the style of an indicator.
648 int wxStyledTextCtrl::IndicatorGetStyle(int indic
) {
649 return SendMsg(2081, indic
, 0);
652 // Set the foreground colour of an indicator.
653 void wxStyledTextCtrl::IndicatorSetForeground(int indic
, const wxColour
& fore
) {
654 SendMsg(2082, indic
, wxColourAsLong(fore
));
657 // Retrieve the foreground colour of an indicator.
658 wxColour
wxStyledTextCtrl::IndicatorGetForeground(int indic
) {
659 long c
= SendMsg(2083, indic
, 0);
660 return wxColourFromLong(c
);
663 // Divide each styling byte into lexical class bits (default:5) and indicator
664 // bits (default:3). If a lexer requires more than 32 lexical states, then this
665 // is used to expand the possible states.
666 void wxStyledTextCtrl::SetStyleBits(int bits
) {
667 SendMsg(2090, bits
, 0);
670 // Retrieve number of bits in style bytes used to hold the lexical state.
671 int wxStyledTextCtrl::GetStyleBits() {
672 return SendMsg(2091, 0, 0);
675 // Used to hold extra styling information for each line.
676 void wxStyledTextCtrl::SetLineState(int line
, int state
) {
677 SendMsg(2092, line
, state
);
680 // Retrieve the extra styling information for a line.
681 int wxStyledTextCtrl::GetLineState(int line
) {
682 return SendMsg(2093, line
, 0);
685 // Retrieve the last line number that has line state.
686 int wxStyledTextCtrl::GetMaxLineState() {
687 return SendMsg(2094, 0, 0);
690 // Is the background of the line containing the caret in a different colour?
691 bool wxStyledTextCtrl::GetCaretLineVisible() {
692 return SendMsg(2095, 0, 0) != 0;
695 // Display the background of the line containing the caret in a different colour.
696 void wxStyledTextCtrl::SetCaretLineVisible(bool show
) {
697 SendMsg(2096, show
, 0);
700 // Get the colour of the background of the line containing the caret.
701 wxColour
wxStyledTextCtrl::GetCaretLineBack() {
702 long c
= SendMsg(2097, 0, 0);
703 return wxColourFromLong(c
);
706 // Set the colour of the background of the line containing the caret.
707 void wxStyledTextCtrl::SetCaretLineBack(const wxColour
& back
) {
708 SendMsg(2098, wxColourAsLong(back
), 0);
711 // Display a auto-completion list.
712 // The lenEntered parameter indicates how many characters before
713 // the caret should be used to provide context.
714 void wxStyledTextCtrl::AutoCompShow(int lenEntered
, const wxString
& itemList
) {
715 SendMsg(2100, lenEntered
, (long)itemList
.c_str());
718 // Remove the auto-completion list from the screen.
719 void wxStyledTextCtrl::AutoCompCancel() {
723 // Is there an auto-completion list visible?
724 bool wxStyledTextCtrl::AutoCompActive() {
725 return SendMsg(2102, 0, 0) != 0;
728 // Retrieve the position of the caret when the auto-completion list was
730 int wxStyledTextCtrl::AutoCompPosStart() {
731 return SendMsg(2103, 0, 0);
734 // User has selected an item so remove the list and insert the selection.
735 void wxStyledTextCtrl::AutoCompComplete() {
739 // Define a set of character that when typed cancel the auto-completion list.
740 void wxStyledTextCtrl::AutoCompStops(const wxString
& characterSet
) {
741 SendMsg(2105, 0, (long)characterSet
.c_str());
744 // Change the separator character in the string setting up an auto-completion
745 // list. Default is space but can be changed if items contain space.
746 void wxStyledTextCtrl::AutoCompSetSeparator(int separatorCharacter
) {
747 SendMsg(2106, separatorCharacter
, 0);
750 // Retrieve the auto-completion list separator character.
751 int wxStyledTextCtrl::AutoCompGetSeparator() {
752 return SendMsg(2107, 0, 0);
755 // Select the item in the auto-completion list that starts with a string.
756 void wxStyledTextCtrl::AutoCompSelect(const wxString
& text
) {
757 SendMsg(2108, 0, (long)text
.c_str());
760 // Should the auto-completion list be cancelled if the user backspaces to a
761 // position before where the box was created.
762 void wxStyledTextCtrl::AutoCompSetCancelAtStart(bool cancel
) {
763 SendMsg(2110, cancel
, 0);
766 // Retrieve whether auto-completion cancelled by backspacing before start.
767 bool wxStyledTextCtrl::AutoCompGetCancelAtStart() {
768 return SendMsg(2111, 0, 0) != 0;
771 // Define a set of character that when typed fills up the selected word.
772 void wxStyledTextCtrl::AutoCompSetFillUps(const wxString
& characterSet
) {
773 SendMsg(2112, 0, (long)characterSet
.c_str());
776 // Should a single item auto-completion list automatically choose the item.
777 void wxStyledTextCtrl::AutoCompSetChooseSingle(bool chooseSingle
) {
778 SendMsg(2113, chooseSingle
, 0);
781 // Retrieve whether a single item auto-completion list automatically choose the item.
782 bool wxStyledTextCtrl::AutoCompGetChooseSingle() {
783 return SendMsg(2114, 0, 0) != 0;
786 // Set whether case is significant when performing auto-completion searches.
787 void wxStyledTextCtrl::AutoCompSetIgnoreCase(bool ignoreCase
) {
788 SendMsg(2115, ignoreCase
, 0);
791 // Retrieve state of ignore case flag.
792 bool wxStyledTextCtrl::AutoCompGetIgnoreCase() {
793 return SendMsg(2116, 0, 0) != 0;
796 // Display a list of strings and send notification when user chooses one.
797 void wxStyledTextCtrl::UserListShow(int listType
, const wxString
& itemList
) {
798 SendMsg(2117, listType
, (long)itemList
.c_str());
801 // Set whether or not autocompletion is hidden automatically when nothing matches
802 void wxStyledTextCtrl::AutoCompSetAutoHide(bool autoHide
) {
803 SendMsg(2118, autoHide
, 0);
806 // Retrieve whether or not autocompletion is hidden automatically when nothing matches
807 bool wxStyledTextCtrl::AutoCompGetAutoHide() {
808 return SendMsg(2119, 0, 0) != 0;
811 // Set the number of spaces used for one level of indentation.
812 void wxStyledTextCtrl::SetIndent(int indentSize
) {
813 SendMsg(2122, indentSize
, 0);
816 // Retrieve indentation size.
817 int wxStyledTextCtrl::GetIndent() {
818 return SendMsg(2123, 0, 0);
821 // Indentation will only use space characters if useTabs is false, otherwise
822 // it will use a combination of tabs and spaces.
823 void wxStyledTextCtrl::SetUseTabs(bool useTabs
) {
824 SendMsg(2124, useTabs
, 0);
827 // Retrieve whether tabs will be used in indentation.
828 bool wxStyledTextCtrl::GetUseTabs() {
829 return SendMsg(2125, 0, 0) != 0;
832 // Change the indentation of a line to a number of columns.
833 void wxStyledTextCtrl::SetLineIndentation(int line
, int indentSize
) {
834 SendMsg(2126, line
, indentSize
);
837 // Retrieve the number of columns that a line is indented.
838 int wxStyledTextCtrl::GetLineIndentation(int line
) {
839 return SendMsg(2127, line
, 0);
842 // Retrieve the position before the first non indentation character on a line.
843 int wxStyledTextCtrl::GetLineIndentPosition(int line
) {
844 return SendMsg(2128, line
, 0);
847 // Retrieve the column number of a position, taking tab width into account.
848 int wxStyledTextCtrl::GetColumn(int pos
) {
849 return SendMsg(2129, pos
, 0);
852 // Show or hide the horizontal scroll bar.
853 void wxStyledTextCtrl::SetUseHorizontalScrollBar(bool show
) {
854 SendMsg(2130, show
, 0);
857 // Is the horizontal scroll bar visible?
858 bool wxStyledTextCtrl::GetUseHorizontalScrollBar() {
859 return SendMsg(2131, 0, 0) != 0;
862 // Show or hide indentation guides.
863 void wxStyledTextCtrl::SetIndentationGuides(bool show
) {
864 SendMsg(2132, show
, 0);
867 // Are the indentation guides visible?
868 bool wxStyledTextCtrl::GetIndentationGuides() {
869 return SendMsg(2133, 0, 0) != 0;
872 // Set the highlighted indentation guide column.
873 // 0 = no highlighted guide.
874 void wxStyledTextCtrl::SetHighlightGuide(int column
) {
875 SendMsg(2134, column
, 0);
878 // Get the highlighted indentation guide column.
879 int wxStyledTextCtrl::GetHighlightGuide() {
880 return SendMsg(2135, 0, 0);
883 // Get the position after the last visible characters on a line.
884 int wxStyledTextCtrl::GetLineEndPosition(int line
) {
885 return SendMsg(2136, line
, 0);
888 // Get the code page used to interpret the bytes of the document as characters.
889 int wxStyledTextCtrl::GetCodePage() {
890 return SendMsg(2137, 0, 0);
893 // Get the foreground colour of the caret.
894 wxColour
wxStyledTextCtrl::GetCaretForeground() {
895 long c
= SendMsg(2138, 0, 0);
896 return wxColourFromLong(c
);
899 // In read-only mode?
900 bool wxStyledTextCtrl::GetReadOnly() {
901 return SendMsg(2140, 0, 0) != 0;
904 // Sets the position of the caret.
905 void wxStyledTextCtrl::SetCurrentPos(int pos
) {
906 SendMsg(2141, pos
, 0);
909 // Sets the position that starts the selection - this becomes the anchor.
910 void wxStyledTextCtrl::SetSelectionStart(int pos
) {
911 SendMsg(2142, pos
, 0);
914 // Returns the position at the start of the selection.
915 int wxStyledTextCtrl::GetSelectionStart() {
916 return SendMsg(2143, 0, 0);
919 // Sets the position that ends the selection - this becomes the currentPosition.
920 void wxStyledTextCtrl::SetSelectionEnd(int pos
) {
921 SendMsg(2144, pos
, 0);
924 // Returns the position at the end of the selection.
925 int wxStyledTextCtrl::GetSelectionEnd() {
926 return SendMsg(2145, 0, 0);
929 // Sets the print magnification added to the point size of each style for printing.
930 void wxStyledTextCtrl::SetPrintMagnification(int magnification
) {
931 SendMsg(2146, magnification
, 0);
934 // Returns the print magnification.
935 int wxStyledTextCtrl::GetPrintMagnification() {
936 return SendMsg(2147, 0, 0);
939 // Modify colours when printing for clearer printed text.
940 void wxStyledTextCtrl::SetPrintColourMode(int mode
) {
941 SendMsg(2148, mode
, 0);
944 // Returns the print colour mode.
945 int wxStyledTextCtrl::GetPrintColourMode() {
946 return SendMsg(2149, 0, 0);
949 // Find some text in the document.
950 int wxStyledTextCtrl::FindText(int minPos
, int maxPos
,
951 const wxString
& text
,
952 bool caseSensitive
, bool wholeWord
) {
956 flags
|= caseSensitive
? SCFIND_MATCHCASE
: 0;
957 flags
|= wholeWord
? SCFIND_WHOLEWORD
: 0;
958 ft
.chrg
.cpMin
= minPos
;
959 ft
.chrg
.cpMax
= maxPos
;
960 ft
.lpstrText
= (char*)text
.c_str();
962 return SendMsg(2150, flags
, (long)&ft
);
965 // On Windows will draw the document into a display context such as a printer.
966 int wxStyledTextCtrl::FormatRange(bool doDraw
,
970 wxDC
* target
, // Why does it use two? Can they be the same?
976 fr
.hdcTarget
= target
;
977 fr
.rc
.top
= renderRect
.GetTop();
978 fr
.rc
.left
= renderRect
.GetLeft();
979 fr
.rc
.right
= renderRect
.GetRight();
980 fr
.rc
.bottom
= renderRect
.GetBottom();
981 fr
.rcPage
.top
= pageRect
.GetTop();
982 fr
.rcPage
.left
= pageRect
.GetLeft();
983 fr
.rcPage
.right
= pageRect
.GetRight();
984 fr
.rcPage
.bottom
= pageRect
.GetBottom();
985 fr
.chrg
.cpMin
= startPos
;
986 fr
.chrg
.cpMax
= endPos
;
988 return SendMsg(2151, doDraw
, (long)&fr
);
991 // Retrieve the line at the top of the display.
992 int wxStyledTextCtrl::GetFirstVisibleLine() {
993 return SendMsg(2152, 0, 0);
996 // Retrieve the contents of a line.
997 wxString
wxStyledTextCtrl::GetLine(int line
) {
999 int len
= LineLength(line
);
1000 if (!len
) return "";
1001 char* buf
= text
.GetWriteBuf(len
);
1003 int pos
= SendMsg(2153, line
, (long)buf
);
1004 text
.UngetWriteBuf(len
);
1009 // Returns the number of lines in the document. There is always at least one.
1010 int wxStyledTextCtrl::GetLineCount() {
1011 return SendMsg(2154, 0, 0);
1014 // Sets the size in pixels of the left margin.
1015 void wxStyledTextCtrl::SetMarginLeft(int pixelWidth
) {
1016 SendMsg(2155, 0, pixelWidth
);
1019 // Returns the size in pixels of the left margin.
1020 int wxStyledTextCtrl::GetMarginLeft() {
1021 return SendMsg(2156, 0, 0);
1024 // Sets the size in pixels of the right margin.
1025 void wxStyledTextCtrl::SetMarginRight(int pixelWidth
) {
1026 SendMsg(2157, 0, pixelWidth
);
1029 // Returns the size in pixels of the right margin.
1030 int wxStyledTextCtrl::GetMarginRight() {
1031 return SendMsg(2158, 0, 0);
1034 // Is the document different from when it was last saved?
1035 bool wxStyledTextCtrl::GetModify() {
1036 return SendMsg(2159, 0, 0) != 0;
1039 // Select a range of text.
1040 void wxStyledTextCtrl::SetSelection(int start
, int end
) {
1041 SendMsg(2160, start
, end
);
1044 // Retrieve the selected text.
1045 wxString
wxStyledTextCtrl::GetSelectedText() {
1050 GetSelection(&start
, &end
);
1051 int len
= end
- start
;
1052 if (!len
) return "";
1053 char* buff
= text
.GetWriteBuf(len
);
1055 SendMsg(2161, 0, (long)buff
);
1056 text
.UngetWriteBuf(len
);
1060 // Retrieve a range of text.
1061 wxString
wxStyledTextCtrl::GetTextRange(int startPos
, int endPos
) {
1063 int len
= endPos
- startPos
;
1064 if (!len
) return "";
1065 char* buff
= text
.GetWriteBuf(len
);
1067 tr
.lpstrText
= buff
;
1068 tr
.chrg
.cpMin
= startPos
;
1069 tr
.chrg
.cpMax
= endPos
;
1071 SendMsg(2162, 0, (long)&tr
);
1072 text
.UngetWriteBuf(len
);
1076 // Draw the selection in normal style or with selection highlighted.
1077 void wxStyledTextCtrl::HideSelection(bool normal
) {
1078 SendMsg(2163, normal
, 0);
1081 // Retrieve the line containing a position.
1082 int wxStyledTextCtrl::LineFromPosition(int pos
) {
1083 return SendMsg(2166, pos
, 0);
1086 // Retrieve the position at the start of a line.
1087 int wxStyledTextCtrl::PositionFromLine(int line
) {
1088 return SendMsg(2167, line
, 0);
1091 // Scroll horizontally and vertically.
1092 void wxStyledTextCtrl::LineScroll(int columns
, int lines
) {
1093 SendMsg(2168, columns
, lines
);
1096 // Ensure the caret is visible.
1097 void wxStyledTextCtrl::EnsureCaretVisible() {
1098 SendMsg(2169, 0, 0);
1101 // Replace the selected text with the argument text.
1102 void wxStyledTextCtrl::ReplaceSelection(const wxString
& text
) {
1103 SendMsg(2170, 0, (long)text
.c_str());
1106 // Set to read only or read write.
1107 void wxStyledTextCtrl::SetReadOnly(bool readOnly
) {
1108 SendMsg(2171, readOnly
, 0);
1111 // Will a paste succeed?
1112 bool wxStyledTextCtrl::CanPaste() {
1113 return SendMsg(2173, 0, 0) != 0;
1116 // Are there any undoable actions in the undo history.
1117 bool wxStyledTextCtrl::CanUndo() {
1118 return SendMsg(2174, 0, 0) != 0;
1121 // Delete the undo history.
1122 void wxStyledTextCtrl::EmptyUndoBuffer() {
1123 SendMsg(2175, 0, 0);
1126 // Undo one action in the undo history.
1127 void wxStyledTextCtrl::Undo() {
1128 SendMsg(2176, 0, 0);
1131 // Cut the selection to the clipboard.
1132 void wxStyledTextCtrl::Cut() {
1133 SendMsg(2177, 0, 0);
1136 // Copy the selection to the clipboard.
1137 void wxStyledTextCtrl::Copy() {
1138 SendMsg(2178, 0, 0);
1141 // Paste the contents of the clipboard into the document replacing the selection.
1142 void wxStyledTextCtrl::Paste() {
1143 SendMsg(2179, 0, 0);
1146 // Clear the selection.
1147 void wxStyledTextCtrl::Clear() {
1148 SendMsg(2180, 0, 0);
1151 // Replace the contents of the document with the argument text.
1152 void wxStyledTextCtrl::SetText(const wxString
& text
) {
1153 SendMsg(2181, 0, (long)text
.c_str());
1156 // Retrieve all the text in the document.
1157 wxString
wxStyledTextCtrl::GetText() {
1159 int len
= GetTextLength();
1160 char* buff
= text
.GetWriteBuf(len
+1); // leave room for the null...
1162 SendMsg(2182, len
+1, (long)buff
);
1163 text
.UngetWriteBuf(len
);
1167 // Retrieve the number of characters in the document.
1168 int wxStyledTextCtrl::GetTextLength() {
1169 return SendMsg(2183, 0, 0);
1172 // Set to overtype (true) or insert mode
1173 void wxStyledTextCtrl::SetOvertype(bool overtype
) {
1174 SendMsg(2186, overtype
, 0);
1177 // Returns true if overtype mode is active otherwise false is returned.
1178 bool wxStyledTextCtrl::GetOvertype() {
1179 return SendMsg(2187, 0, 0) != 0;
1182 // Set the width of the insert mode caret
1183 void wxStyledTextCtrl::SetCaretWidth(int pixelWidth
) {
1184 SendMsg(2188, pixelWidth
, 0);
1187 // Returns the width of the insert mode caret
1188 int wxStyledTextCtrl::GetCaretWidth() {
1189 return SendMsg(2189, 0, 0);
1192 // Sets the position that starts the target which is used for updating the
1193 // document without affecting the scroll position.
1194 void wxStyledTextCtrl::SetTargetStart(int pos
) {
1195 SendMsg(2190, pos
, 0);
1198 // Get the position that starts the target.
1199 int wxStyledTextCtrl::GetTargetStart() {
1200 return SendMsg(2191, 0, 0);
1203 // Sets the position that ends the target which is used for updating the
1204 // document without affecting the scroll position.
1205 void wxStyledTextCtrl::SetTargetEnd(int pos
) {
1206 SendMsg(2192, pos
, 0);
1209 // Get the position that ends the target.
1210 int wxStyledTextCtrl::GetTargetEnd() {
1211 return SendMsg(2193, 0, 0);
1214 // Replace the target text with the argument text.
1215 // Text is counted so it can contain nulls.
1216 // Returns the length of the replacement text.
1218 int wxStyledTextCtrl::ReplaceTarget(const wxString
& text
) {
1219 return SendMsg(2194, text
.Len(), (long)text
.c_str());
1223 // Replace the target text with the argument text after \d processing.
1224 // Text is counted so it can contain nulls.
1225 // Looks for \d where d is between 1 and 9 and replaces these with the strings
1226 // matched in the last search operation which were surrounded by \( and \).
1227 // Returns the length of the replacement text including any change
1228 // caused by processing the \d patterns.
1230 int wxStyledTextCtrl::ReplaceTargetRE(const wxString
& text
) {
1231 return SendMsg(2195, text
.Len(), (long)text
.c_str());
1235 // Search for a counted string in the target and set the target to the found
1236 // range. Text is counted so it can contain nulls.
1237 // Returns length of range or -1 for failure in which case target is not moved.
1239 int wxStyledTextCtrl::SearchInTarget(const wxString
& text
) {
1240 return SendMsg(2197, text
.Len(), (long)text
.c_str());
1244 // Set the search flags used by SearchInTarget
1245 void wxStyledTextCtrl::SetSearchFlags(int flags
) {
1246 SendMsg(2198, flags
, 0);
1249 // Get the search flags used by SearchInTarget
1250 int wxStyledTextCtrl::GetSearchFlags() {
1251 return SendMsg(2199, 0, 0);
1254 // Show a call tip containing a definition near position pos.
1255 void wxStyledTextCtrl::CallTipShow(int pos
, const wxString
& definition
) {
1256 SendMsg(2200, pos
, (long)definition
.c_str());
1259 // Remove the call tip from the screen.
1260 void wxStyledTextCtrl::CallTipCancel() {
1261 SendMsg(2201, 0, 0);
1264 // Is there an active call tip?
1265 bool wxStyledTextCtrl::CallTipActive() {
1266 return SendMsg(2202, 0, 0) != 0;
1269 // Retrieve the position where the caret was before displaying the call tip.
1270 int wxStyledTextCtrl::CallTipPosAtStart() {
1271 return SendMsg(2203, 0, 0);
1274 // Highlight a segment of the definition.
1275 void wxStyledTextCtrl::CallTipSetHighlight(int start
, int end
) {
1276 SendMsg(2204, start
, end
);
1279 // Set the background colour for the call tip.
1280 void wxStyledTextCtrl::CallTipSetBackground(const wxColour
& back
) {
1281 SendMsg(2205, wxColourAsLong(back
), 0);
1284 // Find the display line of a document line taking hidden lines into account.
1285 int wxStyledTextCtrl::VisibleFromDocLine(int line
) {
1286 return SendMsg(2220, line
, 0);
1289 // Find the document line of a display line taking hidden lines into account.
1290 int wxStyledTextCtrl::DocLineFromVisible(int lineDisplay
) {
1291 return SendMsg(2221, lineDisplay
, 0);
1294 // Set the fold level of a line.
1295 // This encodes an integer level along with flags indicating whether the
1296 // line is a header and whether it is effectively white space.
1297 void wxStyledTextCtrl::SetFoldLevel(int line
, int level
) {
1298 SendMsg(2222, line
, level
);
1301 // Retrieve the fold level of a line.
1302 int wxStyledTextCtrl::GetFoldLevel(int line
) {
1303 return SendMsg(2223, line
, 0);
1306 // Find the last child line of a header line.
1307 int wxStyledTextCtrl::GetLastChild(int line
, int level
) {
1308 return SendMsg(2224, line
, level
);
1311 // Find the parent line of a child line.
1312 int wxStyledTextCtrl::GetFoldParent(int line
) {
1313 return SendMsg(2225, line
, 0);
1316 // Make a range of lines visible.
1317 void wxStyledTextCtrl::ShowLines(int lineStart
, int lineEnd
) {
1318 SendMsg(2226, lineStart
, lineEnd
);
1321 // Make a range of lines invisible.
1322 void wxStyledTextCtrl::HideLines(int lineStart
, int lineEnd
) {
1323 SendMsg(2227, lineStart
, lineEnd
);
1326 // Is a line visible?
1327 bool wxStyledTextCtrl::GetLineVisible(int line
) {
1328 return SendMsg(2228, line
, 0) != 0;
1331 // Show the children of a header line.
1332 void wxStyledTextCtrl::SetFoldExpanded(int line
, bool expanded
) {
1333 SendMsg(2229, line
, expanded
);
1336 // Is a header line expanded?
1337 bool wxStyledTextCtrl::GetFoldExpanded(int line
) {
1338 return SendMsg(2230, line
, 0) != 0;
1341 // Switch a header line between expanded and contracted.
1342 void wxStyledTextCtrl::ToggleFold(int line
) {
1343 SendMsg(2231, line
, 0);
1346 // Ensure a particular line is visible by expanding any header line hiding it.
1347 void wxStyledTextCtrl::EnsureVisible(int line
) {
1348 SendMsg(2232, line
, 0);
1351 // Set some debugging options for folding
1352 void wxStyledTextCtrl::SetFoldFlags(int flags
) {
1353 SendMsg(2233, flags
, 0);
1356 // Ensure a particular line is visible by expanding any header line hiding it.
1357 // Use the currently set visibility policy to determine which range to display.
1358 void wxStyledTextCtrl::EnsureVisibleEnforcePolicy(int line
) {
1359 SendMsg(2234, line
, 0);
1362 // Sets whether a tab pressed when caret is within indentation indents
1363 void wxStyledTextCtrl::SetTabIndents(bool tabIndents
) {
1364 SendMsg(2260, tabIndents
, 0);
1367 // Does a tab pressed when caret is within indentation indent?
1368 bool wxStyledTextCtrl::GetTabIndents() {
1369 return SendMsg(2261, 0, 0) != 0;
1372 // Sets whether a backspace pressed when caret is within indentation unindents
1373 void wxStyledTextCtrl::SetBackSpaceUnIndents(bool bsUnIndents
) {
1374 SendMsg(2262, bsUnIndents
, 0);
1377 // Does a backspace pressed when caret is within indentation unindent?
1378 bool wxStyledTextCtrl::GetBackSpaceUnIndents() {
1379 return SendMsg(2263, 0, 0) != 0;
1382 // Sets the time the mouse must sit still to generate a mouse dwell event
1383 void wxStyledTextCtrl::SetMouseDwellTime(int periodMilliseconds
) {
1384 SendMsg(2264, periodMilliseconds
, 0);
1387 // Retrieve the time the mouse must sit still to generate a mouse dwell event
1388 int wxStyledTextCtrl::GetMouseDwellTime() {
1389 return SendMsg(2265, 0, 0);
1392 // Move the caret inside current view if it's not there already
1393 void wxStyledTextCtrl::MoveCaretInsideView() {
1394 SendMsg(2401, 0, 0);
1397 // How many characters are on a line, not including end of line characters.
1398 int wxStyledTextCtrl::LineLength(int line
) {
1399 return SendMsg(2350, line
, 0);
1402 // Highlight the characters at two positions.
1403 void wxStyledTextCtrl::BraceHighlight(int pos1
, int pos2
) {
1404 SendMsg(2351, pos1
, pos2
);
1407 // Highlight the character at a position indicating there is no matching brace.
1408 void wxStyledTextCtrl::BraceBadLight(int pos
) {
1409 SendMsg(2352, pos
, 0);
1412 // Find the position of a matching brace or INVALID_POSITION if no match.
1413 int wxStyledTextCtrl::BraceMatch(int pos
) {
1414 return SendMsg(2353, pos
, 0);
1417 // Are the end of line characters visible.
1418 bool wxStyledTextCtrl::GetViewEOL() {
1419 return SendMsg(2355, 0, 0) != 0;
1422 // Make the end of line characters visible or invisible
1423 void wxStyledTextCtrl::SetViewEOL(bool visible
) {
1424 SendMsg(2356, visible
, 0);
1427 // Retrieve a pointer to the document object.
1428 void* wxStyledTextCtrl::GetDocPointer() {
1429 return (void*)SendMsg(2357);
1432 // Change the document object used.
1433 void wxStyledTextCtrl::SetDocPointer(void* docPointer
) {
1434 SendMsg(2358, 0, (long)docPointer
);
1437 // Set which document modification events are sent to the container.
1438 void wxStyledTextCtrl::SetModEventMask(int mask
) {
1439 SendMsg(2359, mask
, 0);
1442 // Retrieve the column number which text should be kept within.
1443 int wxStyledTextCtrl::GetEdgeColumn() {
1444 return SendMsg(2360, 0, 0);
1447 // Set the column number of the edge.
1448 // If text goes past the edge then it is highlighted.
1449 void wxStyledTextCtrl::SetEdgeColumn(int column
) {
1450 SendMsg(2361, column
, 0);
1453 // Retrieve the edge highlight mode.
1454 int wxStyledTextCtrl::GetEdgeMode() {
1455 return SendMsg(2362, 0, 0);
1458 // The edge may be displayed by a line (EDGE_LINE) or by highlighting text that
1459 // goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
1460 void wxStyledTextCtrl::SetEdgeMode(int mode
) {
1461 SendMsg(2363, mode
, 0);
1464 // Retrieve the colour used in edge indication.
1465 wxColour
wxStyledTextCtrl::GetEdgeColour() {
1466 long c
= SendMsg(2364, 0, 0);
1467 return wxColourFromLong(c
);
1470 // Change the colour used in edge indication.
1471 void wxStyledTextCtrl::SetEdgeColour(const wxColour
& edgeColour
) {
1472 SendMsg(2365, wxColourAsLong(edgeColour
), 0);
1475 // Sets the current caret position to be the search anchor.
1476 void wxStyledTextCtrl::SearchAnchor() {
1477 SendMsg(2366, 0, 0);
1480 // Find some text starting at the search anchor.
1481 // Does not ensure the selection is visible.
1482 int wxStyledTextCtrl::SearchNext(int flags
, const wxString
& text
) {
1483 return SendMsg(2367, flags
, (long)text
.c_str());
1486 // Find some text starting at the search anchor and moving backwards.
1487 // Does not ensure the selection is visible.
1488 int wxStyledTextCtrl::SearchPrev(int flags
, const wxString
& text
) {
1489 return SendMsg(2368, flags
, (long)text
.c_str());
1492 // Set the way the line the caret is on is kept visible.
1493 void wxStyledTextCtrl::SetCaretPolicy(int caretPolicy
, int caretSlop
) {
1494 SendMsg(2369, caretPolicy
, caretSlop
);
1497 // Retrieves the number of lines completely visible.
1498 int wxStyledTextCtrl::LinesOnScreen() {
1499 return SendMsg(2370, 0, 0);
1502 // Set whether a pop up menu is displayed automatically when the user presses
1503 // the wrong mouse button.
1504 void wxStyledTextCtrl::UsePopUp(bool allowPopUp
) {
1505 SendMsg(2371, allowPopUp
, 0);
1508 // Is the selection a rectangular. The alternative is the more common stream selection.
1509 bool wxStyledTextCtrl::SelectionIsRectangle() {
1510 return SendMsg(2372, 0, 0) != 0;
1513 // Set the zoom level. This number of points is added to the size of all fonts.
1514 // It may be positive to magnify or negative to reduce.
1515 void wxStyledTextCtrl::SetZoom(int zoom
) {
1516 SendMsg(2373, zoom
, 0);
1519 // Retrieve the zoom level.
1520 int wxStyledTextCtrl::GetZoom() {
1521 return SendMsg(2374, 0, 0);
1524 // Create a new document object.
1525 // Starts with reference count of 1 and not selected into editor.
1526 void* wxStyledTextCtrl::CreateDocument() {
1527 return (void*)SendMsg(2375);
1530 // Extend life of document.
1531 void wxStyledTextCtrl::AddRefDocument(void* docPointer
) {
1532 SendMsg(2376, (long)docPointer
);
1535 // Release a reference to the document, deleting document if it fades to black.
1536 void wxStyledTextCtrl::ReleaseDocument(void* docPointer
) {
1537 SendMsg(2377, (long)docPointer
);
1540 // Get which document modification events are sent to the container.
1541 int wxStyledTextCtrl::GetModEventMask() {
1542 return SendMsg(2378, 0, 0);
1545 // Change internal focus flag
1546 void wxStyledTextCtrl::SetSTCFocus(bool focus
) {
1547 SendMsg(2380, focus
, 0);
1550 // Get internal focus flag
1551 bool wxStyledTextCtrl::GetSTCFocus() {
1552 return SendMsg(2381, 0, 0) != 0;
1555 // Change error status - 0 = OK
1556 void wxStyledTextCtrl::SetStatus(int statusCode
) {
1557 SendMsg(2382, statusCode
, 0);
1561 int wxStyledTextCtrl::GetStatus() {
1562 return SendMsg(2383, 0, 0);
1565 // Set whether the mouse is captured when its button is pressed
1566 void wxStyledTextCtrl::SetMouseDownCaptures(bool captures
) {
1567 SendMsg(2384, captures
, 0);
1570 // Get whether mouse gets captured
1571 bool wxStyledTextCtrl::GetMouseDownCaptures() {
1572 return SendMsg(2385, 0, 0) != 0;
1575 // Sets the cursor to one of the SC_CURSOR* values
1576 void wxStyledTextCtrl::SetCursor(int cursorType
) {
1577 SendMsg(2386, cursorType
, 0);
1581 int wxStyledTextCtrl::GetCursor() {
1582 return SendMsg(2387, 0, 0);
1585 // Move to the previous change in capitalistion
1586 void wxStyledTextCtrl::WordPartLeft() {
1587 SendMsg(2390, 0, 0);
1590 // Move to the previous change in capitalistion extending selection to new caret position.
1591 void wxStyledTextCtrl::WordPartLeftExtend() {
1592 SendMsg(2391, 0, 0);
1595 // Move to the change next in capitalistion
1596 void wxStyledTextCtrl::WordPartRight() {
1597 SendMsg(2392, 0, 0);
1600 // Move to the next change in capitalistion extending selection to new caret position.
1601 void wxStyledTextCtrl::WordPartRightExtend() {
1602 SendMsg(2393, 0, 0);
1605 // Set the way the display area is determined when a particular line is to be moved to.
1606 void wxStyledTextCtrl::SetVisiblePolicy(int visiblePolicy
, int visibleSlop
) {
1607 SendMsg(2394, visiblePolicy
, visibleSlop
);
1610 // Delete back from the current position to the start of the line
1611 void wxStyledTextCtrl::DelLineLeft() {
1612 SendMsg(2395, 0, 0);
1615 // Delete forwards from the current position to the end of the line
1616 void wxStyledTextCtrl::DelLineRight() {
1617 SendMsg(2396, 0, 0);
1620 // Start notifying the container of all key presses and commands.
1621 void wxStyledTextCtrl::StartRecord() {
1622 SendMsg(3001, 0, 0);
1625 // Stop notifying the container of all key presses and commands.
1626 void wxStyledTextCtrl::StopRecord() {
1627 SendMsg(3002, 0, 0);
1630 // Set the lexing language of the document.
1631 void wxStyledTextCtrl::SetLexer(int lexer
) {
1632 SendMsg(4001, lexer
, 0);
1635 // Retrieve the lexing language of the document.
1636 int wxStyledTextCtrl::GetLexer() {
1637 return SendMsg(4002, 0, 0);
1640 // Colourise a segment of the document using the current lexing language.
1641 void wxStyledTextCtrl::Colourise(int start
, int end
) {
1642 SendMsg(4003, start
, end
);
1645 // Set up a value that may be used by a lexer for some optional feature.
1646 void wxStyledTextCtrl::SetProperty(const wxString
& key
, const wxString
& value
) {
1647 SendMsg(4004, (long)key
.c_str(), (long)value
.c_str());
1650 // Set up the key words used by the lexer.
1651 void wxStyledTextCtrl::SetKeyWords(int keywordSet
, const wxString
& keyWords
) {
1652 SendMsg(4005, keywordSet
, (long)keyWords
.c_str());
1655 // Set the lexing language of the document based on string name.
1656 void wxStyledTextCtrl::SetLexerLanguage(const wxString
& language
) {
1657 SendMsg(4006, 0, (long)language
.c_str());
1660 // END of generated section
1661 //----------------------------------------------------------------------
1664 // Returns the line number of the line with the caret.
1665 int wxStyledTextCtrl::GetCurrentLine() {
1666 int line
= LineFromPosition(GetCurrentPos());
1671 // Extract style settings from a spec-string which is composed of one or
1672 // more of the following comma separated elements:
1674 // bold turns on bold
1675 // italic turns on italics
1676 // fore:#RRGGBB sets the foreground colour
1677 // back:#RRGGBB sets the background colour
1678 // face:[facename] sets the font face name to use
1679 // size:[num] sets the font size in points
1680 // eol turns on eol filling
1681 // underline turns on underlining
1683 void wxStyledTextCtrl::StyleSetSpec(int styleNum
, const wxString
& spec
) {
1685 wxStringTokenizer
tkz(spec
, ",");
1686 while (tkz
.HasMoreTokens()) {
1687 wxString token
= tkz
.GetNextToken();
1689 wxString option
= token
.BeforeFirst(':');
1690 wxString val
= token
.AfterFirst(':');
1692 if (option
== "bold")
1693 StyleSetBold(styleNum
, true);
1695 else if (option
== "italic")
1696 StyleSetItalic(styleNum
, true);
1698 else if (option
== "underline")
1699 StyleSetUnderline(styleNum
, true);
1701 else if (option
== "eol")
1702 StyleSetEOLFilled(styleNum
, true);
1704 else if (option
== "size") {
1706 if (val
.ToLong(&points
))
1707 StyleSetSize(styleNum
, points
);
1710 else if (option
== "face")
1711 StyleSetFaceName(styleNum
, val
);
1713 else if (option
== "fore")
1714 StyleSetForeground(styleNum
, wxColourFromSpec(val
));
1716 else if (option
== "back")
1717 StyleSetBackground(styleNum
, wxColourFromSpec(val
));
1722 // Set style size, face, bold, italic, and underline attributes from
1723 // a wxFont's attributes.
1724 void wxStyledTextCtrl::StyleSetFont(int styleNum
, wxFont
& font
) {
1725 int size
= font
.GetPointSize();
1726 wxString faceName
= font
.GetFaceName();
1727 bool bold
= font
.GetWeight() == wxBOLD
;
1728 bool italic
= font
.GetStyle() != wxNORMAL
;
1729 bool under
= font
.GetUnderlined();
1731 // TODO: add encoding/charset mapping
1732 StyleSetFontAttr(styleNum
, size
, faceName
, bold
, italic
, under
);
1735 // Set all font style attributes at once.
1736 void wxStyledTextCtrl::StyleSetFontAttr(int styleNum
, int size
,
1737 const wxString
& faceName
,
1738 bool bold
, bool italic
,
1740 StyleSetSize(styleNum
, size
);
1741 StyleSetFaceName(styleNum
, faceName
);
1742 StyleSetBold(styleNum
, bold
);
1743 StyleSetItalic(styleNum
, italic
);
1744 StyleSetUnderline(styleNum
, underline
);
1746 // TODO: add encoding/charset mapping
1750 // Perform one of the operations defined by the wxSTC_CMD_* constants.
1751 void wxStyledTextCtrl::CmdKeyExecute(int cmd
) {
1756 // Set the left and right margin in the edit area, measured in pixels.
1757 void wxStyledTextCtrl::SetMargins(int left
, int right
) {
1758 SetMarginLeft(left
);
1759 SetMarginRight(right
);
1763 // Retrieve the start and end positions of the current selection.
1764 void wxStyledTextCtrl::GetSelection(int* startPos
, int* endPos
) {
1765 if (startPos
!= NULL
)
1766 *startPos
= SendMsg(SCI_GETSELECTIONSTART
);
1768 *endPos
= SendMsg(SCI_GETSELECTIONEND
);
1772 // Retrieve the point in the window where a position is displayed.
1773 wxPoint
wxStyledTextCtrl::PointFromPosition(int pos
) {
1774 int x
= SendMsg(SCI_POINTXFROMPOSITION
, 0, pos
);
1775 int y
= SendMsg(SCI_POINTYFROMPOSITION
, 0, pos
);
1776 return wxPoint(x
, y
);
1779 // Scroll enough to make the given line visible
1780 void wxStyledTextCtrl::ScrollToLine(int line
) {
1781 m_swx
->DoScrollToLine(line
);
1785 // Scroll enough to make the given column visible
1786 void wxStyledTextCtrl::ScrollToColumn(int column
) {
1787 m_swx
->DoScrollToColumn(column
);
1792 //----------------------------------------------------------------------
1795 void wxStyledTextCtrl::OnPaint(wxPaintEvent
& evt
) {
1797 wxRegion region
= GetUpdateRegion();
1799 m_swx
->DoPaint(&dc
, region
.GetBox());
1802 void wxStyledTextCtrl::OnScrollWin(wxScrollWinEvent
& evt
) {
1803 if (evt
.GetOrientation() == wxHORIZONTAL
)
1804 m_swx
->DoHScroll(evt
.GetEventType(), evt
.GetPosition());
1806 m_swx
->DoVScroll(evt
.GetEventType(), evt
.GetPosition());
1809 void wxStyledTextCtrl::OnScroll(wxScrollEvent
& evt
) {
1810 wxScrollBar
* sb
= wxDynamicCast(evt
.GetEventObject(), wxScrollBar
);
1812 if (sb
->IsVertical())
1813 m_swx
->DoVScroll(evt
.GetEventType(), evt
.GetPosition());
1815 m_swx
->DoHScroll(evt
.GetEventType(), evt
.GetPosition());
1819 void wxStyledTextCtrl::OnSize(wxSizeEvent
& evt
) {
1820 wxSize sz
= GetClientSize();
1821 m_swx
->DoSize(sz
.x
, sz
.y
);
1824 void wxStyledTextCtrl::OnMouseLeftDown(wxMouseEvent
& evt
) {
1825 wxPoint pt
= evt
.GetPosition();
1826 m_swx
->DoButtonDown(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
1827 evt
.ShiftDown(), evt
.ControlDown(), evt
.AltDown());
1830 void wxStyledTextCtrl::OnMouseMove(wxMouseEvent
& evt
) {
1831 wxPoint pt
= evt
.GetPosition();
1832 m_swx
->DoButtonMove(Point(pt
.x
, pt
.y
));
1835 void wxStyledTextCtrl::OnMouseLeftUp(wxMouseEvent
& evt
) {
1836 wxPoint pt
= evt
.GetPosition();
1837 m_swx
->DoButtonUp(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
1842 void wxStyledTextCtrl::OnMouseRightUp(wxMouseEvent
& evt
) {
1843 wxPoint pt
= evt
.GetPosition();
1844 m_swx
->DoContextMenu(Point(pt
.x
, pt
.y
));
1848 void wxStyledTextCtrl::OnContextMenu(wxContextMenuEvent
& evt
) {
1849 wxPoint pt
= evt
.GetPosition();
1850 ScreenToClient(&pt
.x
, &pt
.y
);
1851 m_swx
->DoContextMenu(Point(pt
.x
, pt
.y
));
1855 void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent
& evt
) {
1856 m_swx
->DoMouseWheel(evt
.GetWheelRotation(),
1857 evt
.GetWheelDelta(),
1858 evt
.GetLinesPerAction(),
1863 void wxStyledTextCtrl::OnChar(wxKeyEvent
& evt
) {
1864 long key
= evt
.KeyCode();
1866 // printf("OnChar key:%d consumed:%d ctrl:%d alt:%d\n",
1867 // key, m_lastKeyDownConsumed, evt.ControlDown(), evt.AltDown());
1870 // \|@#¬[]{}?£$~ ã,õ,Ã,Õ, ñ, Ñ
1872 // On (some?) non-US keyboards the AltGr key is required to enter some
1873 // common characters. It comes to us as both Alt and Ctrl down so we need
1874 // to let the char through in that case, otherwise if only ctrl or only
1875 // alt let's skip it.
1876 bool ctrl
= evt
.ControlDown();
1877 bool alt
= evt
.AltDown();
1878 bool skip
= ((ctrl
|| alt
) && ! (ctrl
&& alt
));
1880 if (key
<= 0xff && key
>= 32 && !m_lastKeyDownConsumed
&& !skip
) {
1881 m_swx
->DoAddChar(key
);
1888 void wxStyledTextCtrl::OnKeyDown(wxKeyEvent
& evt
) {
1889 long key
= evt
.KeyCode();
1890 bool shift
= evt
.ShiftDown(),
1891 ctrl
= evt
.ControlDown(),
1892 alt
= evt
.AltDown();
1894 int processed
= m_swx
->DoKeyDown(key
, shift
, ctrl
, alt
, &m_lastKeyDownConsumed
);
1896 // printf("key: %d shift: %d ctrl: %d alt: %d processed: %d consumed: %d\n",
1897 // key, shift, ctrl, alt, processed, m_lastKeyDownConsumed);
1899 if (!processed
&& !m_lastKeyDownConsumed
)
1904 void wxStyledTextCtrl::OnLoseFocus(wxFocusEvent
& evt
) {
1905 m_swx
->DoLoseFocus();
1909 void wxStyledTextCtrl::OnGainFocus(wxFocusEvent
& evt
) {
1910 m_swx
->DoGainFocus();
1914 void wxStyledTextCtrl::OnSysColourChanged(wxSysColourChangedEvent
& evt
) {
1915 m_swx
->DoSysColourChange();
1919 void wxStyledTextCtrl::OnEraseBackground(wxEraseEvent
& evt
) {
1920 // do nothing to help avoid flashing
1925 void wxStyledTextCtrl::OnMenu(wxCommandEvent
& evt
) {
1926 m_swx
->DoCommand(evt
.GetId());
1930 void wxStyledTextCtrl::OnListBox(wxCommandEvent
& evt
) {
1931 m_swx
->DoOnListBox();
1935 //----------------------------------------------------------------------
1936 // Turn notifications from Scintilla into events
1939 void wxStyledTextCtrl::NotifyChange() {
1940 wxStyledTextEvent
evt(wxEVT_STC_CHANGE
, GetId());
1941 evt
.SetEventObject(this);
1942 GetEventHandler()->ProcessEvent(evt
);
1945 void wxStyledTextCtrl::NotifyParent(SCNotification
* _scn
) {
1946 SCNotification
& scn
= *_scn
;
1947 wxStyledTextEvent
evt(0, GetId());
1949 evt
.SetEventObject(this);
1950 evt
.SetPosition(scn
.position
);
1952 evt
.SetModifiers(scn
.modifiers
);
1954 switch (scn
.nmhdr
.code
) {
1955 case SCN_STYLENEEDED
:
1956 evt
.SetEventType(wxEVT_STC_STYLENEEDED
);
1960 evt
.SetEventType(wxEVT_STC_CHARADDED
);
1963 case SCN_SAVEPOINTREACHED
:
1964 evt
.SetEventType(wxEVT_STC_SAVEPOINTREACHED
);
1967 case SCN_SAVEPOINTLEFT
:
1968 evt
.SetEventType(wxEVT_STC_SAVEPOINTLEFT
);
1971 case SCN_MODIFYATTEMPTRO
:
1972 evt
.SetEventType(wxEVT_STC_ROMODIFYATTEMPT
);
1976 evt
.SetEventType(wxEVT_STC_KEY
);
1979 case SCN_DOUBLECLICK
:
1980 evt
.SetEventType(wxEVT_STC_DOUBLECLICK
);
1984 evt
.SetEventType(wxEVT_STC_UPDATEUI
);
1988 evt
.SetEventType(wxEVT_STC_MODIFIED
);
1989 evt
.SetModificationType(scn
.modificationType
);
1991 evt
.SetText(wxString(scn
.text
, scn
.length
));
1992 evt
.SetLength(scn
.length
);
1993 evt
.SetLinesAdded(scn
.linesAdded
);
1994 evt
.SetLine(scn
.line
);
1995 evt
.SetFoldLevelNow(scn
.foldLevelNow
);
1996 evt
.SetFoldLevelPrev(scn
.foldLevelPrev
);
1999 case SCN_MACRORECORD
:
2000 evt
.SetEventType(wxEVT_STC_MACRORECORD
);
2001 evt
.SetMessage(scn
.message
);
2002 evt
.SetWParam(scn
.wParam
);
2003 evt
.SetLParam(scn
.lParam
);
2006 case SCN_MARGINCLICK
:
2007 evt
.SetEventType(wxEVT_STC_MARGINCLICK
);
2008 evt
.SetMargin(scn
.margin
);
2012 evt
.SetEventType(wxEVT_STC_NEEDSHOWN
);
2013 evt
.SetLength(scn
.length
);
2016 case SCN_POSCHANGED
:
2017 evt
.SetEventType(wxEVT_STC_POSCHANGED
);
2021 evt
.SetEventType(wxEVT_STC_PAINTED
);
2024 case SCN_USERLISTSELECTION
:
2025 evt
.SetEventType(wxEVT_STC_USERLISTSELECTION
);
2026 evt
.SetListType(scn
.listType
);
2027 evt
.SetText(scn
.text
);
2030 case SCN_URIDROPPED
:
2031 evt
.SetEventType(wxEVT_STC_URIDROPPED
);
2032 evt
.SetText(scn
.text
);
2035 case SCN_DWELLSTART
:
2036 evt
.SetEventType(wxEVT_STC_DWELLSTART
);
2042 evt
.SetEventType(wxEVT_STC_DWELLEND
);
2051 GetEventHandler()->ProcessEvent(evt
);
2055 //----------------------------------------------------------------------
2056 //----------------------------------------------------------------------
2057 //----------------------------------------------------------------------
2059 wxStyledTextEvent::wxStyledTextEvent(wxEventType commandType
, int id
)
2060 : wxCommandEvent(commandType
, id
)
2065 m_modificationType
= 0;
2070 m_foldLevelPrev
= 0;
2078 m_dragAllowMove
= FALSE
;
2079 m_dragResult
= wxDragNone
;
2082 bool wxStyledTextEvent::GetShift() const { return (m_modifiers
& SCI_SHIFT
) != 0; }
2083 bool wxStyledTextEvent::GetControl() const { return (m_modifiers
& SCI_CTRL
) != 0; }
2084 bool wxStyledTextEvent::GetAlt() const { return (m_modifiers
& SCI_ALT
) != 0; }
2087 wxStyledTextEvent::wxStyledTextEvent(const wxStyledTextEvent
& event
):
2088 wxCommandEvent(event
)
2090 m_position
= event
.m_position
;
2091 m_key
= event
.m_key
;
2092 m_modifiers
= event
.m_modifiers
;
2093 m_modificationType
= event
.m_modificationType
;
2094 m_text
= event
.m_text
;
2095 m_length
= event
.m_length
;
2096 m_linesAdded
= event
.m_linesAdded
;
2097 m_line
= event
.m_line
;
2098 m_foldLevelNow
= event
.m_foldLevelNow
;
2099 m_foldLevelPrev
= event
.m_foldLevelPrev
;
2101 m_margin
= event
.m_margin
;
2103 m_message
= event
.m_message
;
2104 m_wParam
= event
.m_wParam
;
2105 m_lParam
= event
.m_lParam
;
2107 m_listType
= event
.m_listType
;
2111 m_dragText
= event
.m_dragText
;
2112 m_dragAllowMove
=event
.m_dragAllowMove
;
2113 m_dragResult
= event
.m_dragResult
;
2116 //----------------------------------------------------------------------
2117 //----------------------------------------------------------------------