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 lmEiffel
;
36 extern LexerModule lmHTML
;
37 extern LexerModule lmLISP
;
38 extern LexerModule lmLua
;
39 extern LexerModule lmBatch
; // In LexOthers.cxx
40 extern LexerModule lmPascal
;
41 extern LexerModule lmPerl
;
42 extern LexerModule lmPython
;
43 extern LexerModule lmRuby
;
44 extern LexerModule lmSQL
;
45 extern LexerModule lmVB
;
71 //----------------------------------------------------------------------
73 const wxChar
* wxSTCNameStr
= "stcwindow";
75 DEFINE_EVENT_TYPE( wxEVT_STC_CHANGE
)
76 DEFINE_EVENT_TYPE( wxEVT_STC_STYLENEEDED
)
77 DEFINE_EVENT_TYPE( wxEVT_STC_CHARADDED
)
78 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTREACHED
)
79 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTLEFT
)
80 DEFINE_EVENT_TYPE( wxEVT_STC_ROMODIFYATTEMPT
)
81 DEFINE_EVENT_TYPE( wxEVT_STC_KEY
)
82 DEFINE_EVENT_TYPE( wxEVT_STC_DOUBLECLICK
)
83 DEFINE_EVENT_TYPE( wxEVT_STC_UPDATEUI
)
84 DEFINE_EVENT_TYPE( wxEVT_STC_MODIFIED
)
85 DEFINE_EVENT_TYPE( wxEVT_STC_MACRORECORD
)
86 DEFINE_EVENT_TYPE( wxEVT_STC_MARGINCLICK
)
87 DEFINE_EVENT_TYPE( wxEVT_STC_NEEDSHOWN
)
88 DEFINE_EVENT_TYPE( wxEVT_STC_POSCHANGED
)
89 DEFINE_EVENT_TYPE( wxEVT_STC_PAINTED
)
90 DEFINE_EVENT_TYPE( wxEVT_STC_USERLISTSELECTION
)
91 DEFINE_EVENT_TYPE( wxEVT_STC_URIDROPPED
)
92 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLSTART
)
93 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLEND
)
98 BEGIN_EVENT_TABLE(wxStyledTextCtrl
, wxControl
)
99 EVT_PAINT (wxStyledTextCtrl::OnPaint
)
100 EVT_SCROLLWIN (wxStyledTextCtrl::OnScrollWin
)
101 EVT_SIZE (wxStyledTextCtrl::OnSize
)
102 EVT_LEFT_DOWN (wxStyledTextCtrl::OnMouseLeftDown
)
104 // Let Scintilla see the double click as a second click
105 EVT_LEFT_DCLICK (wxStyledTextCtrl::OnMouseLeftDown
)
107 EVT_MOTION (wxStyledTextCtrl::OnMouseMove
)
108 EVT_LEFT_UP (wxStyledTextCtrl::OnMouseLeftUp
)
109 EVT_CONTEXT_MENU (wxStyledTextCtrl::OnContextMenu
)
110 EVT_MOUSEWHEEL (wxStyledTextCtrl::OnMouseWheel
)
111 EVT_CHAR (wxStyledTextCtrl::OnChar
)
112 EVT_KEY_DOWN (wxStyledTextCtrl::OnKeyDown
)
113 EVT_KILL_FOCUS (wxStyledTextCtrl::OnLoseFocus
)
114 EVT_SET_FOCUS (wxStyledTextCtrl::OnGainFocus
)
115 EVT_SYS_COLOUR_CHANGED (wxStyledTextCtrl::OnSysColourChanged
)
116 EVT_ERASE_BACKGROUND (wxStyledTextCtrl::OnEraseBackground
)
117 EVT_MENU_RANGE (-1, -1, wxStyledTextCtrl::OnMenu
)
118 EVT_LISTBOX_DCLICK (-1, wxStyledTextCtrl::OnListBox
)
122 IMPLEMENT_CLASS(wxStyledTextCtrl
, wxControl
)
123 IMPLEMENT_DYNAMIC_CLASS(wxStyledTextEvent
, wxCommandEvent
)
125 //----------------------------------------------------------------------
126 // Constructor and Destructor
128 wxStyledTextCtrl::wxStyledTextCtrl(wxWindow
*parent
,
133 const wxString
& name
) :
134 wxControl(parent
, id
, pos
, size
,
135 style
| wxVSCROLL
| wxHSCROLL
| wxWANTS_CHARS
| wxCLIP_CHILDREN
,
136 wxDefaultValidator
, name
)
138 m_swx
= new ScintillaWX(this);
140 m_lastKeyDownConsumed
= FALSE
;
144 wxStyledTextCtrl::~wxStyledTextCtrl() {
149 //----------------------------------------------------------------------
151 long wxStyledTextCtrl::SendMsg(int msg
, long wp
, long lp
) {
153 return m_swx
->WndProc(msg
, wp
, lp
);
161 #define MAKELONG(a, b) ((a) | ((b) << 16))
164 static long wxColourAsLong(const wxColour
& co
) {
165 return (((long)co
.Blue() << 16) |
166 ((long)co
.Green() << 8) |
170 static wxColour
wxColourFromLong(long c
) {
172 clr
.Set(c
& 0xff, (c
>> 8) & 0xff, (c
>> 16) & 0xff);
177 static wxColour
wxColourFromSpec(const wxString
& spec
) {
178 // spec should be #RRGGBB
180 int red
= strtol(spec
.Mid(1,2), &junk
, 16);
181 int green
= strtol(spec
.Mid(3,2), &junk
, 16);
182 int blue
= strtol(spec
.Mid(5,2), &junk
, 16);
183 return wxColour(red
, green
, blue
);
187 //----------------------------------------------------------------------
188 // BEGIN generated section. The following code is automatically generated
189 // by gen_iface.py from the contents of Scintilla.iface. Do not edit
190 // this file. Edit stc.cpp.in or gen_iface.py instead and regenerate.
193 // Add text to the document
194 void wxStyledTextCtrl::AddText(const wxString
& text
) {
195 SendMsg(2001, text
.Len(), (long)text
.c_str());
198 // Add array of cells to document
199 void wxStyledTextCtrl::AddStyledText(const wxString
& text
) {
200 SendMsg(2002, text
.Len(), (long)text
.c_str());
203 // Insert string at a position
204 void wxStyledTextCtrl::InsertText(int pos
, const wxString
& text
) {
205 SendMsg(2003, pos
, (long)text
.c_str());
208 // Delete all text in the document
209 void wxStyledTextCtrl::ClearAll() {
213 // Set all style bytes to 0, remove all folding information
214 void wxStyledTextCtrl::ClearDocumentStyle() {
218 // The number of characters in the document
219 int wxStyledTextCtrl::GetLength() {
220 return SendMsg(2006, 0, 0);
223 // Returns the character byte at the position
224 int wxStyledTextCtrl::GetCharAt(int pos
) {
225 return SendMsg(2007, pos
, 0);
228 // Returns the position of the caret
229 int wxStyledTextCtrl::GetCurrentPos() {
230 return SendMsg(2008, 0, 0);
233 // Returns the position of the opposite end of the selection to the caret
234 int wxStyledTextCtrl::GetAnchor() {
235 return SendMsg(2009, 0, 0);
238 // Returns the style byte at the position
239 int wxStyledTextCtrl::GetStyleAt(int pos
) {
240 return SendMsg(2010, pos
, 0);
243 // Redoes the next action on the undo history
244 void wxStyledTextCtrl::Redo() {
248 // Choose between collecting actions into the undo
249 // history and discarding them.
250 void wxStyledTextCtrl::SetUndoCollection(bool collectUndo
) {
251 SendMsg(2012, collectUndo
, 0);
254 // Select all the text in the document.
255 void wxStyledTextCtrl::SelectAll() {
259 // Remember the current position in the undo history as the position
260 // at which the document was saved.
261 void wxStyledTextCtrl::SetSavePoint() {
265 // Retrieve a buffer of cells.
266 wxString
wxStyledTextCtrl::GetStyledText(int startPos
, int endPos
) {
268 int len
= endPos
- startPos
;
271 tr
.lpstrText
= text
.GetWriteBuf(len
*2);
272 tr
.chrg
.cpMin
= startPos
;
273 tr
.chrg
.cpMax
= endPos
;
274 SendMsg(2015, 0, (long)&tr
);
275 text
.UngetWriteBuf(len
*2);
279 // Are there any redoable actions in the undo history.
280 bool wxStyledTextCtrl::CanRedo() {
281 return SendMsg(2016, 0, 0) != 0;
284 // Retrieve the line number at which a particular marker is located
285 int wxStyledTextCtrl::MarkerLineFromHandle(int handle
) {
286 return SendMsg(2017, handle
, 0);
290 void wxStyledTextCtrl::MarkerDeleteHandle(int handle
) {
291 SendMsg(2018, handle
, 0);
294 // Is undo history being collected?
295 bool wxStyledTextCtrl::GetUndoCollection() {
296 return SendMsg(2019, 0, 0) != 0;
299 // Are white space characters currently visible?
300 // Returns one of SCWS_* constants.
301 int wxStyledTextCtrl::GetViewWhiteSpace() {
302 return SendMsg(2020, 0, 0);
305 // Make white space characters invisible, always visible or visible outside indentation.
306 void wxStyledTextCtrl::SetViewWhiteSpace(int viewWS
) {
307 SendMsg(2021, viewWS
, 0);
310 // Find the position from a point within the window.
311 int wxStyledTextCtrl::PositionFromPoint(wxPoint pt
) {
312 return SendMsg(2022, pt
.x
, pt
.y
);
315 // Find the position from a point within the window but return
316 // INVALID_POSITION if not close to text.
317 int wxStyledTextCtrl::PositionFromPointClose(int x
, int y
) {
318 return SendMsg(2023, x
, y
);
321 // Set caret to start of a line and ensure it is visible.
322 void wxStyledTextCtrl::GotoLine(int line
) {
323 SendMsg(2024, line
, 0);
326 // Set caret to a position and ensure it is visible.
327 void wxStyledTextCtrl::GotoPos(int pos
) {
328 SendMsg(2025, pos
, 0);
331 // Set the selection anchor to a position. The anchor is the opposite
332 // end of the selection from the caret.
333 void wxStyledTextCtrl::SetAnchor(int posAnchor
) {
334 SendMsg(2026, posAnchor
, 0);
337 // Retrieve the text of the line containing the caret.
338 // Returns the index of the caret on the line.
339 wxString
wxStyledTextCtrl::GetCurLine(int* linePos
) {
341 int len
= LineLength(GetCurrentLine());
343 if (linePos
) *linePos
= 0;
346 // Need an extra byte because SCI_GETCURLINE writes a null to the string
347 char* buf
= text
.GetWriteBuf(len
+1);
349 int pos
= SendMsg(2027, len
+1, (long)buf
);
350 text
.UngetWriteBuf(len
);
351 if (linePos
) *linePos
= pos
;
356 // Retrieve the position of the last correctly styled character.
357 int wxStyledTextCtrl::GetEndStyled() {
358 return SendMsg(2028, 0, 0);
361 // Convert all line endings in the document to one mode.
362 void wxStyledTextCtrl::ConvertEOLs(int eolMode
) {
363 SendMsg(2029, eolMode
, 0);
366 // Retrieve the current end of line mode - one of CRLF, CR, or LF.
367 int wxStyledTextCtrl::GetEOLMode() {
368 return SendMsg(2030, 0, 0);
371 // Set the current end of line mode.
372 void wxStyledTextCtrl::SetEOLMode(int eolMode
) {
373 SendMsg(2031, eolMode
, 0);
376 // Set the current styling position to pos and the styling mask to mask.
377 // The styling mask can be used to protect some bits in each styling byte from
379 void wxStyledTextCtrl::StartStyling(int pos
, int mask
) {
380 SendMsg(2032, pos
, mask
);
383 // Change style from current styling position for length characters to a style
384 // and move the current styling position to after this newly styled segment.
385 void wxStyledTextCtrl::SetStyling(int length
, int style
) {
386 SendMsg(2033, length
, style
);
389 // Is drawing done first into a buffer or direct to the screen.
390 bool wxStyledTextCtrl::GetBufferedDraw() {
391 return SendMsg(2034, 0, 0) != 0;
394 // If drawing is buffered then each line of text is drawn into a bitmap buffer
395 // before drawing it to the screen to avoid flicker.
396 void wxStyledTextCtrl::SetBufferedDraw(bool buffered
) {
397 SendMsg(2035, buffered
, 0);
400 // Change the visible size of a tab to be a multiple of the width of a space
402 void wxStyledTextCtrl::SetTabWidth(int tabWidth
) {
403 SendMsg(2036, tabWidth
, 0);
406 // Retrieve the visible size of a tab.
407 int wxStyledTextCtrl::GetTabWidth() {
408 return SendMsg(2121, 0, 0);
411 // Set the code page used to interpret the bytes of the document as characters.
412 // The SC_CP_UTF8 value can be used to enter Unicode mode.
413 void wxStyledTextCtrl::SetCodePage(int codePage
) {
414 SendMsg(2037, codePage
, 0);
417 // Set the symbol used for a particular marker number,
418 // and optionally the for and background colours.
419 void wxStyledTextCtrl::MarkerDefine(int markerNumber
, int markerSymbol
,
420 const wxColour
& foreground
,
421 const wxColour
& background
) {
423 SendMsg(2040, markerNumber
, markerSymbol
);
425 MarkerSetForeground(markerNumber
, foreground
);
427 MarkerSetBackground(markerNumber
, background
);
430 // Set the foreground colour used for a particular marker number.
431 void wxStyledTextCtrl::MarkerSetForeground(int markerNumber
, const wxColour
& fore
) {
432 SendMsg(2041, markerNumber
, wxColourAsLong(fore
));
435 // Set the background colour used for a particular marker number.
436 void wxStyledTextCtrl::MarkerSetBackground(int markerNumber
, const wxColour
& back
) {
437 SendMsg(2042, markerNumber
, wxColourAsLong(back
));
440 // Add a marker to a line.
441 void wxStyledTextCtrl::MarkerAdd(int line
, int markerNumber
) {
442 SendMsg(2043, line
, markerNumber
);
445 // Delete a marker from a line
446 void wxStyledTextCtrl::MarkerDelete(int line
, int markerNumber
) {
447 SendMsg(2044, line
, markerNumber
);
450 // Delete all markers with a particular number from all lines
451 void wxStyledTextCtrl::MarkerDeleteAll(int markerNumber
) {
452 SendMsg(2045, markerNumber
, 0);
455 // Get a bit mask of all the markers set on a line.
456 int wxStyledTextCtrl::MarkerGet(int line
) {
457 return SendMsg(2046, line
, 0);
460 // Find the next line after lineStart that includes a marker in mask.
461 int wxStyledTextCtrl::MarkerNext(int lineStart
, int markerMask
) {
462 return SendMsg(2047, lineStart
, markerMask
);
465 // Find the previous line before lineStart that includes a marker in mask.
466 int wxStyledTextCtrl::MarkerPrevious(int lineStart
, int markerMask
) {
467 return SendMsg(2048, lineStart
, markerMask
);
470 // Set a margin to be either numeric or symbolic.
471 void wxStyledTextCtrl::SetMarginType(int margin
, int marginType
) {
472 SendMsg(2240, margin
, marginType
);
475 // Retrieve the type of a margin.
476 int wxStyledTextCtrl::GetMarginType(int margin
) {
477 return SendMsg(2241, margin
, 0);
480 // Set the width of a margin to a width expressed in pixels.
481 void wxStyledTextCtrl::SetMarginWidth(int margin
, int pixelWidth
) {
482 SendMsg(2242, margin
, pixelWidth
);
485 // Retrieve the width of a margin in pixels.
486 int wxStyledTextCtrl::GetMarginWidth(int margin
) {
487 return SendMsg(2243, margin
, 0);
490 // Set a mask that determines which markers are displayed in a margin.
491 void wxStyledTextCtrl::SetMarginMask(int margin
, int mask
) {
492 SendMsg(2244, margin
, mask
);
495 // Retrieve the marker mask of a margin.
496 int wxStyledTextCtrl::GetMarginMask(int margin
) {
497 return SendMsg(2245, margin
, 0);
500 // Make a margin sensitive or insensitive to mouse clicks.
501 void wxStyledTextCtrl::SetMarginSensitive(int margin
, bool sensitive
) {
502 SendMsg(2246, margin
, sensitive
);
505 // Retrieve the mouse click sensitivity of a margin.
506 bool wxStyledTextCtrl::GetMarginSensitive(int margin
) {
507 return SendMsg(2247, margin
, 0) != 0;
510 // Clear all the styles and make equivalent to the global default style.
511 void wxStyledTextCtrl::StyleClearAll() {
515 // Set the foreground colour of a style.
516 void wxStyledTextCtrl::StyleSetForeground(int style
, const wxColour
& fore
) {
517 SendMsg(2051, style
, wxColourAsLong(fore
));
520 // Set the background colour of a style.
521 void wxStyledTextCtrl::StyleSetBackground(int style
, const wxColour
& back
) {
522 SendMsg(2052, style
, wxColourAsLong(back
));
525 // Set a style to be bold or not.
526 void wxStyledTextCtrl::StyleSetBold(int style
, bool bold
) {
527 SendMsg(2053, style
, bold
);
530 // Set a style to be italic or not.
531 void wxStyledTextCtrl::StyleSetItalic(int style
, bool italic
) {
532 SendMsg(2054, style
, italic
);
535 // Set the size of characters of a style.
536 void wxStyledTextCtrl::StyleSetSize(int style
, int sizePoints
) {
537 SendMsg(2055, style
, sizePoints
);
540 // Set the font of a style.
541 void wxStyledTextCtrl::StyleSetFaceName(int style
, const wxString
& fontName
) {
542 SendMsg(2056, style
, (long)fontName
.c_str());
545 // Set a style to have its end of line filled or not.
546 void wxStyledTextCtrl::StyleSetEOLFilled(int style
, bool filled
) {
547 SendMsg(2057, style
, filled
);
550 // Reset the default style to its state at startup
551 void wxStyledTextCtrl::StyleResetDefault() {
555 // Set a style to be underlined or not.
556 void wxStyledTextCtrl::StyleSetUnderline(int style
, bool underline
) {
557 SendMsg(2059, style
, underline
);
560 // Set a style to be mixed case, or to force upper or lower case.
561 void wxStyledTextCtrl::StyleSetCase(int style
, int caseForce
) {
562 SendMsg(2060, style
, caseForce
);
565 // Set the foreground colour of the selection and whether to use this setting.
566 void wxStyledTextCtrl::SetSelForeground(bool useSetting
, const wxColour
& fore
) {
567 SendMsg(2067, useSetting
, wxColourAsLong(fore
));
570 // Set the background colour of the selection and whether to use this setting.
571 void wxStyledTextCtrl::SetSelBackground(bool useSetting
, const wxColour
& back
) {
572 SendMsg(2068, useSetting
, wxColourAsLong(back
));
575 // Set the foreground colour of the caret.
576 void wxStyledTextCtrl::SetCaretForeground(const wxColour
& fore
) {
577 SendMsg(2069, wxColourAsLong(fore
), 0);
580 // When key+modifier combination km is pressed perform msg.
581 void wxStyledTextCtrl::CmdKeyAssign(int key
, int modifiers
, int cmd
) {
582 SendMsg(2070, MAKELONG(key
, modifiers
), cmd
);
585 // When key+modifier combination km do nothing.
586 void wxStyledTextCtrl::CmdKeyClear(int key
, int modifiers
) {
587 SendMsg(2071, MAKELONG(key
, modifiers
));
590 // Drop all key mappings.
591 void wxStyledTextCtrl::CmdKeyClearAll() {
595 // Set the styles for a segment of the document.
596 void wxStyledTextCtrl::SetStyleBytes(int length
, char* styleBytes
) {
597 SendMsg(2073, length
, (long)styleBytes
);
600 // Set a style to be visible or not.
601 void wxStyledTextCtrl::StyleSetVisible(int style
, bool visible
) {
602 SendMsg(2074, style
, visible
);
605 // Get the time in milliseconds that the caret is on and off.
606 int wxStyledTextCtrl::GetCaretPeriod() {
607 return SendMsg(2075, 0, 0);
610 // Get the time in milliseconds that the caret is on and off. 0 = steady on.
611 void wxStyledTextCtrl::SetCaretPeriod(int periodMilliseconds
) {
612 SendMsg(2076, periodMilliseconds
, 0);
615 // Set the set of characters making up words for when moving or selecting
617 void wxStyledTextCtrl::SetWordChars(const wxString
& characters
) {
618 SendMsg(2077, 0, (long)characters
.c_str());
621 // Start a sequence of actions that is undone and redone as a unit.
623 void wxStyledTextCtrl::BeginUndoAction() {
627 // End a sequence of actions that is undone and redone as a unit.
628 void wxStyledTextCtrl::EndUndoAction() {
632 // Set an indicator to plain, squiggle or TT.
633 void wxStyledTextCtrl::IndicatorSetStyle(int indic
, int style
) {
634 SendMsg(2080, indic
, style
);
637 // Retrieve the style of an indicator.
638 int wxStyledTextCtrl::IndicatorGetStyle(int indic
) {
639 return SendMsg(2081, indic
, 0);
642 // Set the foreground colour of an indicator.
643 void wxStyledTextCtrl::IndicatorSetForeground(int indic
, const wxColour
& fore
) {
644 SendMsg(2082, indic
, wxColourAsLong(fore
));
647 // Retrieve the foreground colour of an indicator.
648 wxColour
wxStyledTextCtrl::IndicatorGetForeground(int indic
) {
649 long c
= SendMsg(2083, indic
, 0);
650 return wxColourFromLong(c
);
653 // Divide each styling byte into lexical class bits (default:5) and indicator
654 // bits (default:3). If a lexer requires more than 32 lexical states, then this
655 // is used to expand the possible states.
656 void wxStyledTextCtrl::SetStyleBits(int bits
) {
657 SendMsg(2090, bits
, 0);
660 // Retrieve number of bits in style bytes used to hold the lexical state.
661 int wxStyledTextCtrl::GetStyleBits() {
662 return SendMsg(2091, 0, 0);
665 // Used to hold extra styling information for each line.
666 void wxStyledTextCtrl::SetLineState(int line
, int state
) {
667 SendMsg(2092, line
, state
);
670 // Retrieve the extra styling information for a line.
671 int wxStyledTextCtrl::GetLineState(int line
) {
672 return SendMsg(2093, line
, 0);
675 // Retrieve the last line number that has line state.
676 int wxStyledTextCtrl::GetMaxLineState() {
677 return SendMsg(2094, 0, 0);
680 // Is the background of the line containing the caret in a different colour?
681 bool wxStyledTextCtrl::GetCaretLineVisible() {
682 return SendMsg(2095, 0, 0) != 0;
685 // Display the background of the line containing the caret in a different colour.
686 void wxStyledTextCtrl::SetCaretLineVisible(bool show
) {
687 SendMsg(2096, show
, 0);
690 // Get the colour of the background of the line containing the caret.
691 wxColour
wxStyledTextCtrl::GetCaretLineBack() {
692 long c
= SendMsg(2097, 0, 0);
693 return wxColourFromLong(c
);
696 // Set the colour of the background of the line containing the caret.
697 void wxStyledTextCtrl::SetCaretLineBack(const wxColour
& back
) {
698 SendMsg(2098, wxColourAsLong(back
), 0);
701 // Display a auto-completion list.
702 // The lenEntered parameter indicates how many characters before
703 // the caret should be used to provide context.
704 void wxStyledTextCtrl::AutoCompShow(int lenEntered
, const wxString
& itemList
) {
705 SendMsg(2100, lenEntered
, (long)itemList
.c_str());
708 // Remove the auto-completion list from the screen.
709 void wxStyledTextCtrl::AutoCompCancel() {
713 // Is there an auto-completion list visible?
714 bool wxStyledTextCtrl::AutoCompActive() {
715 return SendMsg(2102, 0, 0) != 0;
718 // Retrieve the position of the caret when the auto-completion list was
720 int wxStyledTextCtrl::AutoCompPosStart() {
721 return SendMsg(2103, 0, 0);
724 // User has selected an item so remove the list and insert the selection.
725 void wxStyledTextCtrl::AutoCompComplete() {
729 // Define a set of character that when typed cancel the auto-completion list.
730 void wxStyledTextCtrl::AutoCompStops(const wxString
& characterSet
) {
731 SendMsg(2105, 0, (long)characterSet
.c_str());
734 // Change the separator character in the string setting up an auto-completion
735 // list. Default is space but can be changed if items contain space.
736 void wxStyledTextCtrl::AutoCompSetSeparator(int separatorCharacter
) {
737 SendMsg(2106, separatorCharacter
, 0);
740 // Retrieve the auto-completion list separator character.
741 int wxStyledTextCtrl::AutoCompGetSeparator() {
742 return SendMsg(2107, 0, 0);
745 // Select the item in the auto-completion list that starts with a string.
746 void wxStyledTextCtrl::AutoCompSelect(const wxString
& text
) {
747 SendMsg(2108, 0, (long)text
.c_str());
750 // Should the auto-completion list be cancelled if the user backspaces to a
751 // position before where the box was created.
752 void wxStyledTextCtrl::AutoCompSetCancelAtStart(bool cancel
) {
753 SendMsg(2110, cancel
, 0);
756 // Retrieve whether auto-completion cancelled by backspacing before start.
757 bool wxStyledTextCtrl::AutoCompGetCancelAtStart() {
758 return SendMsg(2111, 0, 0) != 0;
761 // Define a set of character that when typed fills up the selected word.
762 void wxStyledTextCtrl::AutoCompSetFillUps(const wxString
& characterSet
) {
763 SendMsg(2112, 0, (long)characterSet
.c_str());
766 // Should a single item auto-completion list automatically choose the item.
767 void wxStyledTextCtrl::AutoCompSetChooseSingle(bool chooseSingle
) {
768 SendMsg(2113, chooseSingle
, 0);
771 // Retrieve whether a single item auto-completion list automatically choose the item.
772 bool wxStyledTextCtrl::AutoCompGetChooseSingle() {
773 return SendMsg(2114, 0, 0) != 0;
776 // Set whether case is significant when performing auto-completion searches.
777 void wxStyledTextCtrl::AutoCompSetIgnoreCase(bool ignoreCase
) {
778 SendMsg(2115, ignoreCase
, 0);
781 // Retrieve state of ignore case flag.
782 bool wxStyledTextCtrl::AutoCompGetIgnoreCase() {
783 return SendMsg(2116, 0, 0) != 0;
786 // Display a list of strings and send notification when user chooses one.
787 void wxStyledTextCtrl::UserListShow(int listType
, const wxString
& itemList
) {
788 SendMsg(2117, listType
, (long)itemList
.c_str());
791 // Set whether or not autocompletion is hidden automatically when nothing matches
792 void wxStyledTextCtrl::AutoCompSetAutoHide(bool autoHide
) {
793 SendMsg(2118, autoHide
, 0);
796 // Retrieve whether or not autocompletion is hidden automatically when nothing matches
797 bool wxStyledTextCtrl::AutoCompGetAutoHide() {
798 return SendMsg(2119, 0, 0) != 0;
801 // Set the number of spaces used for one level of indentation.
802 void wxStyledTextCtrl::SetIndent(int indentSize
) {
803 SendMsg(2122, indentSize
, 0);
806 // Retrieve indentation size.
807 int wxStyledTextCtrl::GetIndent() {
808 return SendMsg(2123, 0, 0);
811 // Indentation will only use space characters if useTabs is false, otherwise
812 // it will use a combination of tabs and spaces.
813 void wxStyledTextCtrl::SetUseTabs(bool useTabs
) {
814 SendMsg(2124, useTabs
, 0);
817 // Retrieve whether tabs will be used in indentation.
818 bool wxStyledTextCtrl::GetUseTabs() {
819 return SendMsg(2125, 0, 0) != 0;
822 // Change the indentation of a line to a number of columns.
823 void wxStyledTextCtrl::SetLineIndentation(int line
, int indentSize
) {
824 SendMsg(2126, line
, indentSize
);
827 // Retrieve the number of columns that a line is indented.
828 int wxStyledTextCtrl::GetLineIndentation(int line
) {
829 return SendMsg(2127, line
, 0);
832 // Retrieve the position before the first non indentation character on a line.
833 int wxStyledTextCtrl::GetLineIndentPosition(int line
) {
834 return SendMsg(2128, line
, 0);
837 // Retrieve the column number of a position, taking tab width into account.
838 int wxStyledTextCtrl::GetColumn(int pos
) {
839 return SendMsg(2129, pos
, 0);
842 // Show or hide the horizontal scroll bar.
843 void wxStyledTextCtrl::SetUseHorizontalScrollBar(bool show
) {
844 SendMsg(2130, show
, 0);
847 // Is the horizontal scroll bar visible?
848 bool wxStyledTextCtrl::GetUseHorizontalScrollBar() {
849 return SendMsg(2131, 0, 0) != 0;
852 // Show or hide indentation guides.
853 void wxStyledTextCtrl::SetIndentationGuides(bool show
) {
854 SendMsg(2132, show
, 0);
857 // Are the indentation guides visible?
858 bool wxStyledTextCtrl::GetIndentationGuides() {
859 return SendMsg(2133, 0, 0) != 0;
862 // Set the highlighted indentation guide column.
863 // 0 = no highlighted guide.
864 void wxStyledTextCtrl::SetHighlightGuide(int column
) {
865 SendMsg(2134, column
, 0);
868 // Get the highlighted indentation guide column.
869 int wxStyledTextCtrl::GetHighlightGuide() {
870 return SendMsg(2135, 0, 0);
873 // Get the position after the last visible characters on a line.
874 int wxStyledTextCtrl::GetLineEndPosition(int line
) {
875 return SendMsg(2136, line
, 0);
878 // Get the code page used to interpret the bytes of the document as characters.
879 int wxStyledTextCtrl::GetCodePage() {
880 return SendMsg(2137, 0, 0);
883 // Get the foreground colour of the caret.
884 wxColour
wxStyledTextCtrl::GetCaretForeground() {
885 long c
= SendMsg(2138, 0, 0);
886 return wxColourFromLong(c
);
889 // In read-only mode?
890 bool wxStyledTextCtrl::GetReadOnly() {
891 return SendMsg(2140, 0, 0) != 0;
894 // Sets the position of the caret.
895 void wxStyledTextCtrl::SetCurrentPos(int pos
) {
896 SendMsg(2141, pos
, 0);
899 // Sets the position that starts the selection - this becomes the anchor.
900 void wxStyledTextCtrl::SetSelectionStart(int pos
) {
901 SendMsg(2142, pos
, 0);
904 // Returns the position at the start of the selection.
905 int wxStyledTextCtrl::GetSelectionStart() {
906 return SendMsg(2143, 0, 0);
909 // Sets the position that ends the selection - this becomes the currentPosition.
910 void wxStyledTextCtrl::SetSelectionEnd(int pos
) {
911 SendMsg(2144, pos
, 0);
914 // Returns the position at the end of the selection.
915 int wxStyledTextCtrl::GetSelectionEnd() {
916 return SendMsg(2145, 0, 0);
919 // Sets the print magnification added to the point size of each style for printing.
920 void wxStyledTextCtrl::SetPrintMagnification(int magnification
) {
921 SendMsg(2146, magnification
, 0);
924 // Returns the print magnification.
925 int wxStyledTextCtrl::GetPrintMagnification() {
926 return SendMsg(2147, 0, 0);
929 // Modify colours when printing for clearer printed text.
930 void wxStyledTextCtrl::SetPrintColourMode(int mode
) {
931 SendMsg(2148, mode
, 0);
934 // Returns the print colour mode.
935 int wxStyledTextCtrl::GetPrintColourMode() {
936 return SendMsg(2149, 0, 0);
939 // Find some text in the document.
940 int wxStyledTextCtrl::FindText(int minPos
, int maxPos
,
941 const wxString
& text
,
942 bool caseSensitive
, bool wholeWord
) {
946 flags
|= caseSensitive
? SCFIND_MATCHCASE
: 0;
947 flags
|= wholeWord
? SCFIND_WHOLEWORD
: 0;
948 ft
.chrg
.cpMin
= minPos
;
949 ft
.chrg
.cpMax
= maxPos
;
950 ft
.lpstrText
= (char*)text
.c_str();
952 return SendMsg(2150, flags
, (long)&ft
);
955 // On Windows will draw the document into a display context such as a printer.
956 int wxStyledTextCtrl::FormatRange(bool doDraw
,
960 wxDC
* target
, // Why does it use two? Can they be the same?
966 fr
.hdcTarget
= target
;
967 fr
.rc
.top
= renderRect
.GetTop();
968 fr
.rc
.left
= renderRect
.GetLeft();
969 fr
.rc
.right
= renderRect
.GetRight();
970 fr
.rc
.bottom
= renderRect
.GetBottom();
971 fr
.rcPage
.top
= pageRect
.GetTop();
972 fr
.rcPage
.left
= pageRect
.GetLeft();
973 fr
.rcPage
.right
= pageRect
.GetRight();
974 fr
.rcPage
.bottom
= pageRect
.GetBottom();
975 fr
.chrg
.cpMin
= startPos
;
976 fr
.chrg
.cpMax
= endPos
;
978 return SendMsg(2151, doDraw
, (long)&fr
);
981 // Retrieve the line at the top of the display.
982 int wxStyledTextCtrl::GetFirstVisibleLine() {
983 return SendMsg(2152, 0, 0);
986 // Retrieve the contents of a line.
987 wxString
wxStyledTextCtrl::GetLine(int line
) {
989 int len
= LineLength(line
);
991 char* buf
= text
.GetWriteBuf(len
);
993 int pos
= SendMsg(2153, line
, (long)buf
);
994 text
.UngetWriteBuf(len
);
999 // Returns the number of lines in the document. There is always at least one.
1000 int wxStyledTextCtrl::GetLineCount() {
1001 return SendMsg(2154, 0, 0);
1004 // Sets the size in pixels of the left margin.
1005 void wxStyledTextCtrl::SetMarginLeft(int pixelWidth
) {
1006 SendMsg(2155, 0, pixelWidth
);
1009 // Returns the size in pixels of the left margin.
1010 int wxStyledTextCtrl::GetMarginLeft() {
1011 return SendMsg(2156, 0, 0);
1014 // Sets the size in pixels of the right margin.
1015 void wxStyledTextCtrl::SetMarginRight(int pixelWidth
) {
1016 SendMsg(2157, 0, pixelWidth
);
1019 // Returns the size in pixels of the right margin.
1020 int wxStyledTextCtrl::GetMarginRight() {
1021 return SendMsg(2158, 0, 0);
1024 // Is the document different from when it was last saved?
1025 bool wxStyledTextCtrl::GetModify() {
1026 return SendMsg(2159, 0, 0) != 0;
1029 // Select a range of text.
1030 void wxStyledTextCtrl::SetSelection(int start
, int end
) {
1031 SendMsg(2160, start
, end
);
1034 // Retrieve the selected text.
1035 wxString
wxStyledTextCtrl::GetSelectedText() {
1040 GetSelection(&start
, &end
);
1041 int len
= end
- start
;
1042 if (!len
) return "";
1043 char* buff
= text
.GetWriteBuf(len
);
1045 SendMsg(2161, 0, (long)buff
);
1046 text
.UngetWriteBuf(len
);
1050 // Retrieve a range of text.
1051 wxString
wxStyledTextCtrl::GetTextRange(int startPos
, int endPos
) {
1053 int len
= endPos
- startPos
;
1054 if (!len
) return "";
1055 char* buff
= text
.GetWriteBuf(len
);
1057 tr
.lpstrText
= buff
;
1058 tr
.chrg
.cpMin
= startPos
;
1059 tr
.chrg
.cpMax
= endPos
;
1061 SendMsg(2162, 0, (long)&tr
);
1062 text
.UngetWriteBuf(len
);
1066 // Draw the selection in normal style or with selection highlighted.
1067 void wxStyledTextCtrl::HideSelection(bool normal
) {
1068 SendMsg(2163, normal
, 0);
1071 // Retrieve the line containing a position.
1072 int wxStyledTextCtrl::LineFromPosition(int pos
) {
1073 return SendMsg(2166, pos
, 0);
1076 // Retrieve the position at the start of a line.
1077 int wxStyledTextCtrl::PositionFromLine(int line
) {
1078 return SendMsg(2167, line
, 0);
1081 // Scroll horizontally and vertically.
1082 void wxStyledTextCtrl::LineScroll(int columns
, int lines
) {
1083 SendMsg(2168, columns
, lines
);
1086 // Ensure the caret is visible.
1087 void wxStyledTextCtrl::EnsureCaretVisible() {
1088 SendMsg(2169, 0, 0);
1091 // Replace the selected text with the argument text.
1092 void wxStyledTextCtrl::ReplaceSelection(const wxString
& text
) {
1093 SendMsg(2170, 0, (long)text
.c_str());
1096 // Set to read only or read write.
1097 void wxStyledTextCtrl::SetReadOnly(bool readOnly
) {
1098 SendMsg(2171, readOnly
, 0);
1101 // Will a paste succeed?
1102 bool wxStyledTextCtrl::CanPaste() {
1103 return SendMsg(2173, 0, 0) != 0;
1106 // Are there any undoable actions in the undo history.
1107 bool wxStyledTextCtrl::CanUndo() {
1108 return SendMsg(2174, 0, 0) != 0;
1111 // Delete the undo history.
1112 void wxStyledTextCtrl::EmptyUndoBuffer() {
1113 SendMsg(2175, 0, 0);
1116 // Undo one action in the undo history.
1117 void wxStyledTextCtrl::Undo() {
1118 SendMsg(2176, 0, 0);
1121 // Cut the selection to the clipboard.
1122 void wxStyledTextCtrl::Cut() {
1123 SendMsg(2177, 0, 0);
1126 // Copy the selection to the clipboard.
1127 void wxStyledTextCtrl::Copy() {
1128 SendMsg(2178, 0, 0);
1131 // Paste the contents of the clipboard into the document replacing the selection.
1132 void wxStyledTextCtrl::Paste() {
1133 SendMsg(2179, 0, 0);
1136 // Clear the selection.
1137 void wxStyledTextCtrl::Clear() {
1138 SendMsg(2180, 0, 0);
1141 // Replace the contents of the document with the argument text.
1142 void wxStyledTextCtrl::SetText(const wxString
& text
) {
1143 SendMsg(2181, 0, (long)text
.c_str());
1146 // Retrieve all the text in the document.
1147 wxString
wxStyledTextCtrl::GetText() {
1149 int len
= GetTextLength();
1150 char* buff
= text
.GetWriteBuf(len
+1); // leave room for the null...
1152 SendMsg(2182, len
+1, (long)buff
);
1153 text
.UngetWriteBuf(len
);
1157 // Retrieve the number of characters in the document.
1158 int wxStyledTextCtrl::GetTextLength() {
1159 return SendMsg(2183, 0, 0);
1162 // Set to overtype (true) or insert mode
1163 void wxStyledTextCtrl::SetOvertype(bool overtype
) {
1164 SendMsg(2186, overtype
, 0);
1167 // Returns true if overtype mode is active otherwise false is returned.
1168 bool wxStyledTextCtrl::GetOvertype() {
1169 return SendMsg(2187, 0, 0) != 0;
1172 // Set the width of the insert mode caret
1173 void wxStyledTextCtrl::SetCaretWidth(int pixelWidth
) {
1174 SendMsg(2188, pixelWidth
, 0);
1177 // Returns the width of the insert mode caret
1178 int wxStyledTextCtrl::GetCaretWidth() {
1179 return SendMsg(2189, 0, 0);
1182 // Sets the position that starts the target which is used for updating the
1183 // document without affecting the scroll position.
1184 void wxStyledTextCtrl::SetTargetStart(int pos
) {
1185 SendMsg(2190, pos
, 0);
1188 // Get the position that starts the target.
1189 int wxStyledTextCtrl::GetTargetStart() {
1190 return SendMsg(2191, 0, 0);
1193 // Sets the position that ends the target which is used for updating the
1194 // document without affecting the scroll position.
1195 void wxStyledTextCtrl::SetTargetEnd(int pos
) {
1196 SendMsg(2192, pos
, 0);
1199 // Get the position that ends the target.
1200 int wxStyledTextCtrl::GetTargetEnd() {
1201 return SendMsg(2193, 0, 0);
1204 // Replace the target text with the argument text.
1205 // Returns the length of the replacement text.
1207 int wxStyledTextCtrl::ReplaceTarget(const wxString
& text
) {
1208 return SendMsg(2194, text
.Len(), (long)text
.c_str());
1212 // Replace the target text with the argument text after \d processing.
1213 // Looks for \d where d is between 1 and 9 and replaces these with the strings
1214 // matched in the last search operation which were surrounded by \( and \).
1215 // Returns the length of the replacement text including any change
1216 // caused by processing the \d patterns.
1218 int wxStyledTextCtrl::ReplaceTargetRE(const wxString
& text
) {
1219 return SendMsg(2195, text
.Len(), (long)text
.c_str());
1223 // Search for a counted string in the target and set the target to the found
1225 // Returns length of range or -1 for failure in which case target is not moved.
1227 int wxStyledTextCtrl::SearchInTarget(const wxString
& text
) {
1228 return SendMsg(2197, text
.Len(), (long)text
.c_str());
1232 // Set the search flags used by SearchInTarget
1233 void wxStyledTextCtrl::SetSearchFlags(int flags
) {
1234 SendMsg(2198, flags
, 0);
1237 // Get the search flags used by SearchInTarget
1238 int wxStyledTextCtrl::GetSearchFlags() {
1239 return SendMsg(2199, 0, 0);
1242 // Show a call tip containing a definition near position pos.
1243 void wxStyledTextCtrl::CallTipShow(int pos
, const wxString
& definition
) {
1244 SendMsg(2200, pos
, (long)definition
.c_str());
1247 // Remove the call tip from the screen.
1248 void wxStyledTextCtrl::CallTipCancel() {
1249 SendMsg(2201, 0, 0);
1252 // Is there an active call tip?
1253 bool wxStyledTextCtrl::CallTipActive() {
1254 return SendMsg(2202, 0, 0) != 0;
1257 // Retrieve the position where the caret was before displaying the call tip.
1258 int wxStyledTextCtrl::CallTipPosAtStart() {
1259 return SendMsg(2203, 0, 0);
1262 // Highlight a segment of the definition.
1263 void wxStyledTextCtrl::CallTipSetHighlight(int start
, int end
) {
1264 SendMsg(2204, start
, end
);
1267 // Set the background colour for the call tip.
1268 void wxStyledTextCtrl::CallTipSetBackground(const wxColour
& back
) {
1269 SendMsg(2205, wxColourAsLong(back
), 0);
1272 // Find the display line of a document line taking hidden lines into account.
1273 int wxStyledTextCtrl::VisibleFromDocLine(int line
) {
1274 return SendMsg(2220, line
, 0);
1277 // Find the document line of a display line taking hidden lines into account.
1278 int wxStyledTextCtrl::DocLineFromVisible(int lineDisplay
) {
1279 return SendMsg(2221, lineDisplay
, 0);
1282 // Set the fold level of a line.
1283 // This encodes an integer level along with flags indicating whether the
1284 // line is a header and whether it is effectively white space.
1285 void wxStyledTextCtrl::SetFoldLevel(int line
, int level
) {
1286 SendMsg(2222, line
, level
);
1289 // Retrieve the fold level of a line.
1290 int wxStyledTextCtrl::GetFoldLevel(int line
) {
1291 return SendMsg(2223, line
, 0);
1294 // Find the last child line of a header line.
1295 int wxStyledTextCtrl::GetLastChild(int line
, int level
) {
1296 return SendMsg(2224, line
, level
);
1299 // Find the parent line of a child line.
1300 int wxStyledTextCtrl::GetFoldParent(int line
) {
1301 return SendMsg(2225, line
, 0);
1304 // Make a range of lines visible.
1305 void wxStyledTextCtrl::ShowLines(int lineStart
, int lineEnd
) {
1306 SendMsg(2226, lineStart
, lineEnd
);
1309 // Make a range of lines invisible.
1310 void wxStyledTextCtrl::HideLines(int lineStart
, int lineEnd
) {
1311 SendMsg(2227, lineStart
, lineEnd
);
1314 // Is a line visible?
1315 bool wxStyledTextCtrl::GetLineVisible(int line
) {
1316 return SendMsg(2228, line
, 0) != 0;
1319 // Show the children of a header line.
1320 void wxStyledTextCtrl::SetFoldExpanded(int line
, bool expanded
) {
1321 SendMsg(2229, line
, expanded
);
1324 // Is a header line expanded?
1325 bool wxStyledTextCtrl::GetFoldExpanded(int line
) {
1326 return SendMsg(2230, line
, 0) != 0;
1329 // Switch a header line between expanded and contracted.
1330 void wxStyledTextCtrl::ToggleFold(int line
) {
1331 SendMsg(2231, line
, 0);
1334 // Ensure a particular line is visible by expanding any header line hiding it.
1335 void wxStyledTextCtrl::EnsureVisible(int line
) {
1336 SendMsg(2232, line
, 0);
1339 // Set some debugging options for folding
1340 void wxStyledTextCtrl::SetFoldFlags(int flags
) {
1341 SendMsg(2233, flags
, 0);
1344 // Ensure a particular line is visible by expanding any header line hiding it.
1345 // Use the currently set visibility policy to determine which range to display.
1346 void wxStyledTextCtrl::EnsureVisibleEnforcePolicy(int line
) {
1347 SendMsg(2234, line
, 0);
1350 // Sets whether a tab pressed when caret is within indentation indents
1351 void wxStyledTextCtrl::SetTabIndents(bool tabIndents
) {
1352 SendMsg(2260, tabIndents
, 0);
1355 // Does a tab pressed when caret is within indentation indent?
1356 bool wxStyledTextCtrl::GetTabIndents() {
1357 return SendMsg(2261, 0, 0) != 0;
1360 // Sets whether a backspace pressed when caret is within indentation unindents
1361 void wxStyledTextCtrl::SetBackSpaceUnIndents(bool bsUnIndents
) {
1362 SendMsg(2262, bsUnIndents
, 0);
1365 // Does a backspace pressed when caret is within indentation unindent?
1366 bool wxStyledTextCtrl::GetBackSpaceUnIndents() {
1367 return SendMsg(2263, 0, 0) != 0;
1370 // Sets the time the mouse must sit still to generate a mouse dwell event
1371 void wxStyledTextCtrl::SetMouseDwellTime(int periodMilliseconds
) {
1372 SendMsg(2264, periodMilliseconds
, 0);
1375 // Retrieve the time the mouse must sit still to generate a mouse dwell event
1376 int wxStyledTextCtrl::GetMouseDwellTime() {
1377 return SendMsg(2265, 0, 0);
1380 // Move the caret inside current view if it's not there already
1381 void wxStyledTextCtrl::MoveCaretInsideView() {
1382 SendMsg(2401, 0, 0);
1385 // How many characters are on a line, not including end of line characters.
1386 int wxStyledTextCtrl::LineLength(int line
) {
1387 return SendMsg(2350, line
, 0);
1390 // Highlight the characters at two positions.
1391 void wxStyledTextCtrl::BraceHighlight(int pos1
, int pos2
) {
1392 SendMsg(2351, pos1
, pos2
);
1395 // Highlight the character at a position indicating there is no matching brace.
1396 void wxStyledTextCtrl::BraceBadLight(int pos
) {
1397 SendMsg(2352, pos
, 0);
1400 // Find the position of a matching brace or INVALID_POSITION if no match.
1401 int wxStyledTextCtrl::BraceMatch(int pos
) {
1402 return SendMsg(2353, pos
, 0);
1405 // Are the end of line characters visible.
1406 bool wxStyledTextCtrl::GetViewEOL() {
1407 return SendMsg(2355, 0, 0) != 0;
1410 // Make the end of line characters visible or invisible
1411 void wxStyledTextCtrl::SetViewEOL(bool visible
) {
1412 SendMsg(2356, visible
, 0);
1415 // Retrieve a pointer to the document object.
1416 void* wxStyledTextCtrl::GetDocPointer() {
1417 return (void*)SendMsg(2357);
1420 // Change the document object used.
1421 void wxStyledTextCtrl::SetDocPointer(void* docPointer
) {
1422 SendMsg(2358, 0, (long)docPointer
);
1425 // Set which document modification events are sent to the container.
1426 void wxStyledTextCtrl::SetModEventMask(int mask
) {
1427 SendMsg(2359, mask
, 0);
1430 // Retrieve the column number which text should be kept within.
1431 int wxStyledTextCtrl::GetEdgeColumn() {
1432 return SendMsg(2360, 0, 0);
1435 // Set the column number of the edge.
1436 // If text goes past the edge then it is highlighted.
1437 void wxStyledTextCtrl::SetEdgeColumn(int column
) {
1438 SendMsg(2361, column
, 0);
1441 // Retrieve the edge highlight mode.
1442 int wxStyledTextCtrl::GetEdgeMode() {
1443 return SendMsg(2362, 0, 0);
1446 // The edge may be displayed by a line (EDGE_LINE) or by highlighting text that
1447 // goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
1448 void wxStyledTextCtrl::SetEdgeMode(int mode
) {
1449 SendMsg(2363, mode
, 0);
1452 // Retrieve the colour used in edge indication.
1453 wxColour
wxStyledTextCtrl::GetEdgeColour() {
1454 long c
= SendMsg(2364, 0, 0);
1455 return wxColourFromLong(c
);
1458 // Change the colour used in edge indication.
1459 void wxStyledTextCtrl::SetEdgeColour(const wxColour
& edgeColour
) {
1460 SendMsg(2365, wxColourAsLong(edgeColour
), 0);
1463 // Sets the current caret position to be the search anchor.
1464 void wxStyledTextCtrl::SearchAnchor() {
1465 SendMsg(2366, 0, 0);
1468 // Find some text starting at the search anchor.
1469 // Does not ensure the selection is visible.
1470 int wxStyledTextCtrl::SearchNext(int flags
, const wxString
& text
) {
1471 return SendMsg(2367, flags
, (long)text
.c_str());
1474 // Find some text starting at the search anchor and moving backwards.
1475 // Does not ensure the selection is visible.
1476 int wxStyledTextCtrl::SearchPrev(int flags
, const wxString
& text
) {
1477 return SendMsg(2368, flags
, (long)text
.c_str());
1480 // Set the way the line the caret is on is kept visible.
1481 void wxStyledTextCtrl::SetCaretPolicy(int caretPolicy
, int caretSlop
) {
1482 SendMsg(2369, caretPolicy
, caretSlop
);
1485 // Retrieves the number of lines completely visible.
1486 int wxStyledTextCtrl::LinesOnScreen() {
1487 return SendMsg(2370, 0, 0);
1490 // Set whether a pop up menu is displayed automatically when the user presses
1491 // the wrong mouse button.
1492 void wxStyledTextCtrl::UsePopUp(bool allowPopUp
) {
1493 SendMsg(2371, allowPopUp
, 0);
1496 // Is the selection a rectangular. The alternative is the more common stream selection.
1497 bool wxStyledTextCtrl::SelectionIsRectangle() {
1498 return SendMsg(2372, 0, 0) != 0;
1501 // Set the zoom level. This number of points is added to the size of all fonts.
1502 // It may be positive to magnify or negative to reduce.
1503 void wxStyledTextCtrl::SetZoom(int zoom
) {
1504 SendMsg(2373, zoom
, 0);
1507 // Retrieve the zoom level.
1508 int wxStyledTextCtrl::GetZoom() {
1509 return SendMsg(2374, 0, 0);
1512 // Create a new document object.
1513 // Starts with reference count of 1 and not selected into editor.
1514 void* wxStyledTextCtrl::CreateDocument() {
1515 return (void*)SendMsg(2375);
1518 // Extend life of document.
1519 void wxStyledTextCtrl::AddRefDocument(void* docPointer
) {
1520 SendMsg(2376, (long)docPointer
);
1523 // Release a reference to the document, deleting document if it fades to black.
1524 void wxStyledTextCtrl::ReleaseDocument(void* docPointer
) {
1525 SendMsg(2377, (long)docPointer
);
1528 // Get which document modification events are sent to the container.
1529 int wxStyledTextCtrl::GetModEventMask() {
1530 return SendMsg(2378, 0, 0);
1533 // Change internal focus flag
1534 void wxStyledTextCtrl::SetSTCFocus(bool focus
) {
1535 SendMsg(2380, focus
, 0);
1538 // Get internal focus flag
1539 bool wxStyledTextCtrl::GetSTCFocus() {
1540 return SendMsg(2381, 0, 0) != 0;
1543 // Change error status - 0 = OK
1544 void wxStyledTextCtrl::SetStatus(int statusCode
) {
1545 SendMsg(2382, statusCode
, 0);
1549 int wxStyledTextCtrl::GetStatus() {
1550 return SendMsg(2383, 0, 0);
1553 // Set whether the mouse is captured when its button is pressed
1554 void wxStyledTextCtrl::SetMouseDownCaptures(bool captures
) {
1555 SendMsg(2384, captures
, 0);
1558 // Get whether mouse gets captured
1559 bool wxStyledTextCtrl::GetMouseDownCaptures() {
1560 return SendMsg(2385, 0, 0) != 0;
1563 // Sets the cursor to one of the SC_CURSOR* values
1564 void wxStyledTextCtrl::SetCursor(int cursorType
) {
1565 SendMsg(2386, cursorType
, 0);
1569 int wxStyledTextCtrl::GetCursor() {
1570 return SendMsg(2387, 0, 0);
1573 // Move to the previous change in capitalistion
1574 void wxStyledTextCtrl::WordPartLeft() {
1575 SendMsg(2390, 0, 0);
1578 // Move to the previous change in capitalistion extending selection to new caret position.
1579 void wxStyledTextCtrl::WordPartLeftExtend() {
1580 SendMsg(2391, 0, 0);
1583 // Move to the change next in capitalistion
1584 void wxStyledTextCtrl::WordPartRight() {
1585 SendMsg(2392, 0, 0);
1588 // Move to the next change in capitalistion extending selection to new caret position.
1589 void wxStyledTextCtrl::WordPartRightExtend() {
1590 SendMsg(2393, 0, 0);
1593 // Set the way the display area is determined when a particular line is to be moved to.
1594 void wxStyledTextCtrl::SetVisiblePolicy(int visiblePolicy
, int visibleSlop
) {
1595 SendMsg(2394, visiblePolicy
, visibleSlop
);
1598 // Delete back from the current position to the start of the line
1599 void wxStyledTextCtrl::DelLineLeft() {
1600 SendMsg(2395, 0, 0);
1603 // Delete forwards from the current position to the end of the line
1604 void wxStyledTextCtrl::DelLineRight() {
1605 SendMsg(2396, 0, 0);
1608 // Start notifying the container of all key presses and commands.
1609 void wxStyledTextCtrl::StartRecord() {
1610 SendMsg(3001, 0, 0);
1613 // Stop notifying the container of all key presses and commands.
1614 void wxStyledTextCtrl::StopRecord() {
1615 SendMsg(3002, 0, 0);
1618 // Set the lexing language of the document.
1619 void wxStyledTextCtrl::SetLexer(int lexer
) {
1620 SendMsg(4001, lexer
, 0);
1623 // Retrieve the lexing language of the document.
1624 int wxStyledTextCtrl::GetLexer() {
1625 return SendMsg(4002, 0, 0);
1628 // Colourise a segment of the document using the current lexing language.
1629 void wxStyledTextCtrl::Colourise(int start
, int end
) {
1630 SendMsg(4003, start
, end
);
1633 // Set up a value that may be used by a lexer for some optional feature.
1634 void wxStyledTextCtrl::SetProperty(const wxString
& key
, const wxString
& value
) {
1635 SendMsg(4004, (long)key
.c_str(), (long)value
.c_str());
1638 // Set up the key words used by the lexer.
1639 void wxStyledTextCtrl::SetKeyWords(int keywordSet
, const wxString
& keyWords
) {
1640 SendMsg(4005, keywordSet
, (long)keyWords
.c_str());
1643 // Set the lexing language of the document based on string name.
1644 void wxStyledTextCtrl::SetLexerLanguage(const wxString
& language
) {
1645 SendMsg(4006, 0, (long)language
.c_str());
1648 // END of generated section
1649 //----------------------------------------------------------------------
1652 // Returns the line number of the line with the caret.
1653 int wxStyledTextCtrl::GetCurrentLine() {
1654 int line
= LineFromPosition(GetCurrentPos());
1659 // Extract style settings from a spec-string which is composed of one or
1660 // more of the following comma separated elements:
1662 // bold turns on bold
1663 // italic turns on italics
1664 // fore:#RRGGBB sets the foreground colour
1665 // back:#RRGGBB sets the background colour
1666 // face:[facename] sets the font face name to use
1667 // size:[num] sets the font size in points
1668 // eol turns on eol filling
1669 // underline turns on underlining
1671 void wxStyledTextCtrl::StyleSetSpec(int styleNum
, const wxString
& spec
) {
1673 wxStringTokenizer
tkz(spec
, ",");
1674 while (tkz
.HasMoreTokens()) {
1675 wxString token
= tkz
.GetNextToken();
1677 wxString option
= token
.BeforeFirst(':');
1678 wxString val
= token
.AfterFirst(':');
1680 if (option
== "bold")
1681 StyleSetBold(styleNum
, true);
1683 else if (option
== "italic")
1684 StyleSetItalic(styleNum
, true);
1686 else if (option
== "underline")
1687 StyleSetUnderline(styleNum
, true);
1689 else if (option
== "eol")
1690 StyleSetEOLFilled(styleNum
, true);
1692 else if (option
== "size") {
1694 if (val
.ToLong(&points
))
1695 StyleSetSize(styleNum
, points
);
1698 else if (option
== "face")
1699 StyleSetFaceName(styleNum
, val
);
1701 else if (option
== "fore")
1702 StyleSetForeground(styleNum
, wxColourFromSpec(val
));
1704 else if (option
== "back")
1705 StyleSetBackground(styleNum
, wxColourFromSpec(val
));
1710 // Set style size, face, bold, italic, and underline attributes from
1711 // a wxFont's attributes.
1712 void wxStyledTextCtrl::StyleSetFont(int styleNum
, wxFont
& font
) {
1713 int size
= font
.GetPointSize();
1714 wxString faceName
= font
.GetFaceName();
1715 bool bold
= font
.GetWeight() == wxBOLD
;
1716 bool italic
= font
.GetStyle() != wxNORMAL
;
1717 bool under
= font
.GetUnderlined();
1719 // TODO: add encoding/charset mapping
1720 StyleSetFontAttr(styleNum
, size
, faceName
, bold
, italic
, under
);
1723 // Set all font style attributes at once.
1724 void wxStyledTextCtrl::StyleSetFontAttr(int styleNum
, int size
,
1725 const wxString
& faceName
,
1726 bool bold
, bool italic
,
1728 StyleSetSize(styleNum
, size
);
1729 StyleSetFaceName(styleNum
, faceName
);
1730 StyleSetBold(styleNum
, bold
);
1731 StyleSetItalic(styleNum
, italic
);
1732 StyleSetUnderline(styleNum
, underline
);
1734 // TODO: add encoding/charset mapping
1738 // Perform one of the operations defined by the wxSTC_CMD_* constants.
1739 void wxStyledTextCtrl::CmdKeyExecute(int cmd
) {
1744 // Set the left and right margin in the edit area, measured in pixels.
1745 void wxStyledTextCtrl::SetMargins(int left
, int right
) {
1746 SetMarginLeft(left
);
1747 SetMarginRight(right
);
1751 // Retrieve the start and end positions of the current selection.
1752 void wxStyledTextCtrl::GetSelection(int* startPos
, int* endPos
) {
1753 if (startPos
!= NULL
)
1754 *startPos
= SendMsg(SCI_GETSELECTIONSTART
);
1756 *endPos
= SendMsg(SCI_GETSELECTIONEND
);
1760 // Retrieve the point in the window where a position is displayed.
1761 wxPoint
wxStyledTextCtrl::PointFromPosition(int pos
) {
1762 int x
= SendMsg(SCI_POINTXFROMPOSITION
, 0, pos
);
1763 int y
= SendMsg(SCI_POINTYFROMPOSITION
, 0, pos
);
1764 return wxPoint(x
, y
);
1767 // Scroll enough to make the given line visible
1768 void wxStyledTextCtrl::ScrollToLine(int line
) {
1769 m_swx
->DoScrollToLine(line
);
1773 // Scroll enough to make the given column visible
1774 void wxStyledTextCtrl::ScrollToColumn(int column
) {
1775 m_swx
->DoScrollToColumn(column
);
1780 //----------------------------------------------------------------------
1783 void wxStyledTextCtrl::OnPaint(wxPaintEvent
& evt
) {
1785 wxRegion region
= GetUpdateRegion();
1787 m_swx
->DoPaint(&dc
, region
.GetBox());
1790 void wxStyledTextCtrl::OnScrollWin(wxScrollWinEvent
& evt
) {
1791 if (evt
.GetOrientation() == wxHORIZONTAL
)
1792 m_swx
->DoHScroll(evt
.GetEventType(), evt
.GetPosition());
1794 m_swx
->DoVScroll(evt
.GetEventType(), evt
.GetPosition());
1797 void wxStyledTextCtrl::OnSize(wxSizeEvent
& evt
) {
1798 wxSize sz
= GetClientSize();
1799 m_swx
->DoSize(sz
.x
, sz
.y
);
1802 void wxStyledTextCtrl::OnMouseLeftDown(wxMouseEvent
& evt
) {
1803 wxPoint pt
= evt
.GetPosition();
1804 m_swx
->DoButtonDown(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
1805 evt
.ShiftDown(), evt
.ControlDown(), evt
.AltDown());
1808 void wxStyledTextCtrl::OnMouseMove(wxMouseEvent
& evt
) {
1809 wxPoint pt
= evt
.GetPosition();
1810 m_swx
->DoButtonMove(Point(pt
.x
, pt
.y
));
1813 void wxStyledTextCtrl::OnMouseLeftUp(wxMouseEvent
& evt
) {
1814 wxPoint pt
= evt
.GetPosition();
1815 m_swx
->DoButtonUp(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
1820 void wxStyledTextCtrl::OnContextMenu(wxContextMenuEvent
& evt
) {
1821 wxPoint pt
= evt
.GetPosition();
1822 ScreenToClient(&pt
.x
, &pt
.y
);
1823 m_swx
->DoContextMenu(Point(pt
.x
, pt
.y
));
1827 void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent
& evt
) {
1828 m_swx
->DoMouseWheel(evt
.GetWheelRotation(),
1829 evt
.GetWheelDelta(),
1830 evt
.GetLinesPerAction(),
1835 void wxStyledTextCtrl::OnChar(wxKeyEvent
& evt
) {
1836 long key
= evt
.KeyCode();
1837 if (key
<= 0xff && !iscntrl(key
) && !m_lastKeyDownConsumed
) {
1838 m_swx
->DoAddChar(key
);
1843 void wxStyledTextCtrl::OnKeyDown(wxKeyEvent
& evt
) {
1844 long key
= evt
.KeyCode();
1845 int processed
= m_swx
->DoKeyDown(key
,
1849 &m_lastKeyDownConsumed
);
1850 if (!processed
&& !m_lastKeyDownConsumed
)
1855 void wxStyledTextCtrl::OnLoseFocus(wxFocusEvent
& evt
) {
1856 m_swx
->DoLoseFocus();
1860 void wxStyledTextCtrl::OnGainFocus(wxFocusEvent
& evt
) {
1861 m_swx
->DoGainFocus();
1865 void wxStyledTextCtrl::OnSysColourChanged(wxSysColourChangedEvent
& evt
) {
1866 m_swx
->DoSysColourChange();
1870 void wxStyledTextCtrl::OnEraseBackground(wxEraseEvent
& evt
) {
1871 // do nothing to help avoid flashing
1876 void wxStyledTextCtrl::OnMenu(wxCommandEvent
& evt
) {
1877 m_swx
->DoCommand(evt
.GetId());
1881 void wxStyledTextCtrl::OnListBox(wxCommandEvent
& evt
) {
1882 m_swx
->DoOnListBox();
1886 //----------------------------------------------------------------------
1887 // Turn notifications from Scintilla into events
1890 void wxStyledTextCtrl::NotifyChange() {
1891 wxStyledTextEvent
evt(wxEVT_STC_CHANGE
, GetId());
1892 GetEventHandler()->ProcessEvent(evt
);
1895 void wxStyledTextCtrl::NotifyParent(SCNotification
* _scn
) {
1896 SCNotification
& scn
= *_scn
;
1897 wxStyledTextEvent
evt(0, GetId());
1899 evt
.SetPosition(scn
.position
);
1901 evt
.SetModifiers(scn
.modifiers
);
1903 switch (scn
.nmhdr
.code
) {
1904 case SCN_STYLENEEDED
:
1905 evt
.SetEventType(wxEVT_STC_STYLENEEDED
);
1909 evt
.SetEventType(wxEVT_STC_CHARADDED
);
1912 case SCN_SAVEPOINTREACHED
:
1913 evt
.SetEventType(wxEVT_STC_SAVEPOINTREACHED
);
1916 case SCN_SAVEPOINTLEFT
:
1917 evt
.SetEventType(wxEVT_STC_SAVEPOINTLEFT
);
1920 case SCN_MODIFYATTEMPTRO
:
1921 evt
.SetEventType(wxEVT_STC_ROMODIFYATTEMPT
);
1925 evt
.SetEventType(wxEVT_STC_KEY
);
1928 case SCN_DOUBLECLICK
:
1929 evt
.SetEventType(wxEVT_STC_DOUBLECLICK
);
1933 evt
.SetEventType(wxEVT_STC_UPDATEUI
);
1937 evt
.SetEventType(wxEVT_STC_MODIFIED
);
1938 evt
.SetModificationType(scn
.modificationType
);
1940 evt
.SetText(wxString(scn
.text
, scn
.length
));
1941 evt
.SetLength(scn
.length
);
1942 evt
.SetLinesAdded(scn
.linesAdded
);
1943 evt
.SetLine(scn
.line
);
1944 evt
.SetFoldLevelNow(scn
.foldLevelNow
);
1945 evt
.SetFoldLevelPrev(scn
.foldLevelPrev
);
1948 case SCN_MACRORECORD
:
1949 evt
.SetEventType(wxEVT_STC_MACRORECORD
);
1950 evt
.SetMessage(scn
.message
);
1951 evt
.SetWParam(scn
.wParam
);
1952 evt
.SetLParam(scn
.lParam
);
1955 case SCN_MARGINCLICK
:
1956 evt
.SetEventType(wxEVT_STC_MARGINCLICK
);
1957 evt
.SetMargin(scn
.margin
);
1961 evt
.SetEventType(wxEVT_STC_NEEDSHOWN
);
1962 evt
.SetLength(scn
.length
);
1965 case SCN_POSCHANGED
:
1966 evt
.SetEventType(wxEVT_STC_POSCHANGED
);
1970 evt
.SetEventType(wxEVT_STC_PAINTED
);
1973 case SCN_USERLISTSELECTION
:
1974 evt
.SetEventType(wxEVT_STC_USERLISTSELECTION
);
1975 evt
.SetListType(scn
.listType
);
1976 evt
.SetText(scn
.text
);
1979 case SCN_URIDROPPED
:
1980 evt
.SetEventType(wxEVT_STC_URIDROPPED
);
1981 evt
.SetText(scn
.text
);
1984 case SCN_DWELLSTART
:
1985 evt
.SetEventType(wxEVT_STC_DWELLSTART
);
1991 evt
.SetEventType(wxEVT_STC_DWELLEND
);
2000 GetEventHandler()->ProcessEvent(evt
);
2005 //----------------------------------------------------------------------
2006 //----------------------------------------------------------------------
2007 //----------------------------------------------------------------------
2009 wxStyledTextEvent::wxStyledTextEvent(wxEventType commandType
, int id
)
2010 : wxCommandEvent(commandType
, id
)
2015 m_modificationType
= 0;
2020 m_foldLevelPrev
= 0;
2030 bool wxStyledTextEvent::GetShift() const { return (m_modifiers
& SCI_SHIFT
) != 0; }
2031 bool wxStyledTextEvent::GetControl() const { return (m_modifiers
& SCI_CTRL
) != 0; }
2032 bool wxStyledTextEvent::GetAlt() const { return (m_modifiers
& SCI_ALT
) != 0; }
2034 void wxStyledTextEvent::CopyObject(wxObject
& obj
) const {
2035 wxCommandEvent::CopyObject(obj
);
2037 wxStyledTextEvent
* o
= (wxStyledTextEvent
*)&obj
;
2038 o
->m_position
= m_position
;
2040 o
->m_modifiers
= m_modifiers
;
2041 o
->m_modificationType
= m_modificationType
;
2043 o
->m_length
= m_length
;
2044 o
->m_linesAdded
= m_linesAdded
;
2046 o
->m_foldLevelNow
= m_foldLevelNow
;
2047 o
->m_foldLevelPrev
= m_foldLevelPrev
;
2049 o
->m_margin
= m_margin
;
2051 o
->m_message
= m_message
;
2052 o
->m_wParam
= m_wParam
;
2053 o
->m_lParam
= m_lParam
;
2055 o
->m_listType
= m_listType
;
2061 //----------------------------------------------------------------------
2062 //----------------------------------------------------------------------