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
)
100 BEGIN_EVENT_TABLE(wxStyledTextCtrl
, wxControl
)
101 EVT_PAINT (wxStyledTextCtrl::OnPaint
)
102 EVT_SCROLLWIN (wxStyledTextCtrl::OnScrollWin
)
103 EVT_SIZE (wxStyledTextCtrl::OnSize
)
104 EVT_LEFT_DOWN (wxStyledTextCtrl::OnMouseLeftDown
)
106 // Let Scintilla see the double click as a second click
107 EVT_LEFT_DCLICK (wxStyledTextCtrl::OnMouseLeftDown
)
109 EVT_MOTION (wxStyledTextCtrl::OnMouseMove
)
110 EVT_LEFT_UP (wxStyledTextCtrl::OnMouseLeftUp
)
111 EVT_CONTEXT_MENU (wxStyledTextCtrl::OnContextMenu
)
112 EVT_MOUSEWHEEL (wxStyledTextCtrl::OnMouseWheel
)
113 EVT_CHAR (wxStyledTextCtrl::OnChar
)
114 EVT_KEY_DOWN (wxStyledTextCtrl::OnKeyDown
)
115 EVT_KILL_FOCUS (wxStyledTextCtrl::OnLoseFocus
)
116 EVT_SET_FOCUS (wxStyledTextCtrl::OnGainFocus
)
117 EVT_SYS_COLOUR_CHANGED (wxStyledTextCtrl::OnSysColourChanged
)
118 EVT_ERASE_BACKGROUND (wxStyledTextCtrl::OnEraseBackground
)
119 EVT_MENU_RANGE (-1, -1, wxStyledTextCtrl::OnMenu
)
120 EVT_LISTBOX_DCLICK (-1, wxStyledTextCtrl::OnListBox
)
124 IMPLEMENT_CLASS(wxStyledTextCtrl
, wxControl
)
125 IMPLEMENT_DYNAMIC_CLASS(wxStyledTextEvent
, wxCommandEvent
)
127 //----------------------------------------------------------------------
128 // Constructor and Destructor
130 wxStyledTextCtrl::wxStyledTextCtrl(wxWindow
*parent
,
135 const wxString
& name
) :
136 wxControl(parent
, id
, pos
, size
,
137 style
| wxVSCROLL
| wxHSCROLL
| wxWANTS_CHARS
| wxCLIP_CHILDREN
,
138 wxDefaultValidator
, name
)
140 m_swx
= new ScintillaWX(this);
142 m_lastKeyDownConsumed
= FALSE
;
146 wxStyledTextCtrl::~wxStyledTextCtrl() {
151 //----------------------------------------------------------------------
153 long wxStyledTextCtrl::SendMsg(int msg
, long wp
, long lp
) {
155 return m_swx
->WndProc(msg
, wp
, lp
);
163 #define MAKELONG(a, b) ((a) | ((b) << 16))
166 static long wxColourAsLong(const wxColour
& co
) {
167 return (((long)co
.Blue() << 16) |
168 ((long)co
.Green() << 8) |
172 static wxColour
wxColourFromLong(long c
) {
174 clr
.Set(c
& 0xff, (c
>> 8) & 0xff, (c
>> 16) & 0xff);
179 static wxColour
wxColourFromSpec(const wxString
& spec
) {
180 // spec should be #RRGGBB
182 int red
= strtol(spec
.Mid(1,2), &junk
, 16);
183 int green
= strtol(spec
.Mid(3,2), &junk
, 16);
184 int blue
= strtol(spec
.Mid(5,2), &junk
, 16);
185 return wxColour(red
, green
, blue
);
189 //----------------------------------------------------------------------
190 // BEGIN generated section. The following code is automatically generated
191 // by gen_iface.py from the contents of Scintilla.iface. Do not edit
192 // this file. Edit stc.cpp.in or gen_iface.py instead and regenerate.
195 // Add text to the document
196 void wxStyledTextCtrl::AddText(const wxString
& text
) {
197 SendMsg(2001, text
.Len(), (long)text
.c_str());
200 // Add array of cells to document
201 void wxStyledTextCtrl::AddStyledText(const wxString
& text
) {
202 SendMsg(2002, text
.Len(), (long)text
.c_str());
205 // Insert string at a position
206 void wxStyledTextCtrl::InsertText(int pos
, const wxString
& text
) {
207 SendMsg(2003, pos
, (long)text
.c_str());
210 // Delete all text in the document
211 void wxStyledTextCtrl::ClearAll() {
215 // Set all style bytes to 0, remove all folding information
216 void wxStyledTextCtrl::ClearDocumentStyle() {
220 // The number of characters in the document
221 int wxStyledTextCtrl::GetLength() {
222 return SendMsg(2006, 0, 0);
225 // Returns the character byte at the position
226 int wxStyledTextCtrl::GetCharAt(int pos
) {
227 return SendMsg(2007, pos
, 0);
230 // Returns the position of the caret
231 int wxStyledTextCtrl::GetCurrentPos() {
232 return SendMsg(2008, 0, 0);
235 // Returns the position of the opposite end of the selection to the caret
236 int wxStyledTextCtrl::GetAnchor() {
237 return SendMsg(2009, 0, 0);
240 // Returns the style byte at the position
241 int wxStyledTextCtrl::GetStyleAt(int pos
) {
242 return SendMsg(2010, pos
, 0);
245 // Redoes the next action on the undo history
246 void wxStyledTextCtrl::Redo() {
250 // Choose between collecting actions into the undo
251 // history and discarding them.
252 void wxStyledTextCtrl::SetUndoCollection(bool collectUndo
) {
253 SendMsg(2012, collectUndo
, 0);
256 // Select all the text in the document.
257 void wxStyledTextCtrl::SelectAll() {
261 // Remember the current position in the undo history as the position
262 // at which the document was saved.
263 void wxStyledTextCtrl::SetSavePoint() {
267 // Retrieve a buffer of cells.
268 wxString
wxStyledTextCtrl::GetStyledText(int startPos
, int endPos
) {
270 int len
= endPos
- startPos
;
273 tr
.lpstrText
= text
.GetWriteBuf(len
*2);
274 tr
.chrg
.cpMin
= startPos
;
275 tr
.chrg
.cpMax
= endPos
;
276 SendMsg(2015, 0, (long)&tr
);
277 text
.UngetWriteBuf(len
*2);
281 // Are there any redoable actions in the undo history.
282 bool wxStyledTextCtrl::CanRedo() {
283 return SendMsg(2016, 0, 0) != 0;
286 // Retrieve the line number at which a particular marker is located
287 int wxStyledTextCtrl::MarkerLineFromHandle(int handle
) {
288 return SendMsg(2017, handle
, 0);
292 void wxStyledTextCtrl::MarkerDeleteHandle(int handle
) {
293 SendMsg(2018, handle
, 0);
296 // Is undo history being collected?
297 bool wxStyledTextCtrl::GetUndoCollection() {
298 return SendMsg(2019, 0, 0) != 0;
301 // Are white space characters currently visible?
302 // Returns one of SCWS_* constants.
303 int wxStyledTextCtrl::GetViewWhiteSpace() {
304 return SendMsg(2020, 0, 0);
307 // Make white space characters invisible, always visible or visible outside indentation.
308 void wxStyledTextCtrl::SetViewWhiteSpace(int viewWS
) {
309 SendMsg(2021, viewWS
, 0);
312 // Find the position from a point within the window.
313 int wxStyledTextCtrl::PositionFromPoint(wxPoint pt
) {
314 return SendMsg(2022, pt
.x
, pt
.y
);
317 // Find the position from a point within the window but return
318 // INVALID_POSITION if not close to text.
319 int wxStyledTextCtrl::PositionFromPointClose(int x
, int y
) {
320 return SendMsg(2023, x
, y
);
323 // Set caret to start of a line and ensure it is visible.
324 void wxStyledTextCtrl::GotoLine(int line
) {
325 SendMsg(2024, line
, 0);
328 // Set caret to a position and ensure it is visible.
329 void wxStyledTextCtrl::GotoPos(int pos
) {
330 SendMsg(2025, pos
, 0);
333 // Set the selection anchor to a position. The anchor is the opposite
334 // end of the selection from the caret.
335 void wxStyledTextCtrl::SetAnchor(int posAnchor
) {
336 SendMsg(2026, posAnchor
, 0);
339 // Retrieve the text of the line containing the caret.
340 // Returns the index of the caret on the line.
341 wxString
wxStyledTextCtrl::GetCurLine(int* linePos
) {
343 int len
= LineLength(GetCurrentLine());
345 if (linePos
) *linePos
= 0;
348 // Need an extra byte because SCI_GETCURLINE writes a null to the string
349 char* buf
= text
.GetWriteBuf(len
+1);
351 int pos
= SendMsg(2027, len
+1, (long)buf
);
352 text
.UngetWriteBuf(len
);
353 if (linePos
) *linePos
= pos
;
358 // Retrieve the position of the last correctly styled character.
359 int wxStyledTextCtrl::GetEndStyled() {
360 return SendMsg(2028, 0, 0);
363 // Convert all line endings in the document to one mode.
364 void wxStyledTextCtrl::ConvertEOLs(int eolMode
) {
365 SendMsg(2029, eolMode
, 0);
368 // Retrieve the current end of line mode - one of CRLF, CR, or LF.
369 int wxStyledTextCtrl::GetEOLMode() {
370 return SendMsg(2030, 0, 0);
373 // Set the current end of line mode.
374 void wxStyledTextCtrl::SetEOLMode(int eolMode
) {
375 SendMsg(2031, eolMode
, 0);
378 // Set the current styling position to pos and the styling mask to mask.
379 // The styling mask can be used to protect some bits in each styling byte from
381 void wxStyledTextCtrl::StartStyling(int pos
, int mask
) {
382 SendMsg(2032, pos
, mask
);
385 // Change style from current styling position for length characters to a style
386 // and move the current styling position to after this newly styled segment.
387 void wxStyledTextCtrl::SetStyling(int length
, int style
) {
388 SendMsg(2033, length
, style
);
391 // Is drawing done first into a buffer or direct to the screen.
392 bool wxStyledTextCtrl::GetBufferedDraw() {
393 return SendMsg(2034, 0, 0) != 0;
396 // If drawing is buffered then each line of text is drawn into a bitmap buffer
397 // before drawing it to the screen to avoid flicker.
398 void wxStyledTextCtrl::SetBufferedDraw(bool buffered
) {
399 SendMsg(2035, buffered
, 0);
402 // Change the visible size of a tab to be a multiple of the width of a space
404 void wxStyledTextCtrl::SetTabWidth(int tabWidth
) {
405 SendMsg(2036, tabWidth
, 0);
408 // Retrieve the visible size of a tab.
409 int wxStyledTextCtrl::GetTabWidth() {
410 return SendMsg(2121, 0, 0);
413 // Set the code page used to interpret the bytes of the document as characters.
414 // The SC_CP_UTF8 value can be used to enter Unicode mode.
415 void wxStyledTextCtrl::SetCodePage(int codePage
) {
416 SendMsg(2037, codePage
, 0);
419 // Set the symbol used for a particular marker number,
420 // and optionally the for and background colours.
421 void wxStyledTextCtrl::MarkerDefine(int markerNumber
, int markerSymbol
,
422 const wxColour
& foreground
,
423 const wxColour
& background
) {
425 SendMsg(2040, markerNumber
, markerSymbol
);
427 MarkerSetForeground(markerNumber
, foreground
);
429 MarkerSetBackground(markerNumber
, background
);
432 // Set the foreground colour used for a particular marker number.
433 void wxStyledTextCtrl::MarkerSetForeground(int markerNumber
, const wxColour
& fore
) {
434 SendMsg(2041, markerNumber
, wxColourAsLong(fore
));
437 // Set the background colour used for a particular marker number.
438 void wxStyledTextCtrl::MarkerSetBackground(int markerNumber
, const wxColour
& back
) {
439 SendMsg(2042, markerNumber
, wxColourAsLong(back
));
442 // Add a marker to a line.
443 void wxStyledTextCtrl::MarkerAdd(int line
, int markerNumber
) {
444 SendMsg(2043, line
, markerNumber
);
447 // Delete a marker from a line
448 void wxStyledTextCtrl::MarkerDelete(int line
, int markerNumber
) {
449 SendMsg(2044, line
, markerNumber
);
452 // Delete all markers with a particular number from all lines
453 void wxStyledTextCtrl::MarkerDeleteAll(int markerNumber
) {
454 SendMsg(2045, markerNumber
, 0);
457 // Get a bit mask of all the markers set on a line.
458 int wxStyledTextCtrl::MarkerGet(int line
) {
459 return SendMsg(2046, line
, 0);
462 // Find the next line after lineStart that includes a marker in mask.
463 int wxStyledTextCtrl::MarkerNext(int lineStart
, int markerMask
) {
464 return SendMsg(2047, lineStart
, markerMask
);
467 // Find the previous line before lineStart that includes a marker in mask.
468 int wxStyledTextCtrl::MarkerPrevious(int lineStart
, int markerMask
) {
469 return SendMsg(2048, lineStart
, markerMask
);
472 // Set a margin to be either numeric or symbolic.
473 void wxStyledTextCtrl::SetMarginType(int margin
, int marginType
) {
474 SendMsg(2240, margin
, marginType
);
477 // Retrieve the type of a margin.
478 int wxStyledTextCtrl::GetMarginType(int margin
) {
479 return SendMsg(2241, margin
, 0);
482 // Set the width of a margin to a width expressed in pixels.
483 void wxStyledTextCtrl::SetMarginWidth(int margin
, int pixelWidth
) {
484 SendMsg(2242, margin
, pixelWidth
);
487 // Retrieve the width of a margin in pixels.
488 int wxStyledTextCtrl::GetMarginWidth(int margin
) {
489 return SendMsg(2243, margin
, 0);
492 // Set a mask that determines which markers are displayed in a margin.
493 void wxStyledTextCtrl::SetMarginMask(int margin
, int mask
) {
494 SendMsg(2244, margin
, mask
);
497 // Retrieve the marker mask of a margin.
498 int wxStyledTextCtrl::GetMarginMask(int margin
) {
499 return SendMsg(2245, margin
, 0);
502 // Make a margin sensitive or insensitive to mouse clicks.
503 void wxStyledTextCtrl::SetMarginSensitive(int margin
, bool sensitive
) {
504 SendMsg(2246, margin
, sensitive
);
507 // Retrieve the mouse click sensitivity of a margin.
508 bool wxStyledTextCtrl::GetMarginSensitive(int margin
) {
509 return SendMsg(2247, margin
, 0) != 0;
512 // Clear all the styles and make equivalent to the global default style.
513 void wxStyledTextCtrl::StyleClearAll() {
517 // Set the foreground colour of a style.
518 void wxStyledTextCtrl::StyleSetForeground(int style
, const wxColour
& fore
) {
519 SendMsg(2051, style
, wxColourAsLong(fore
));
522 // Set the background colour of a style.
523 void wxStyledTextCtrl::StyleSetBackground(int style
, const wxColour
& back
) {
524 SendMsg(2052, style
, wxColourAsLong(back
));
527 // Set a style to be bold or not.
528 void wxStyledTextCtrl::StyleSetBold(int style
, bool bold
) {
529 SendMsg(2053, style
, bold
);
532 // Set a style to be italic or not.
533 void wxStyledTextCtrl::StyleSetItalic(int style
, bool italic
) {
534 SendMsg(2054, style
, italic
);
537 // Set the size of characters of a style.
538 void wxStyledTextCtrl::StyleSetSize(int style
, int sizePoints
) {
539 SendMsg(2055, style
, sizePoints
);
542 // Set the font of a style.
543 void wxStyledTextCtrl::StyleSetFaceName(int style
, const wxString
& fontName
) {
544 SendMsg(2056, style
, (long)fontName
.c_str());
547 // Set a style to have its end of line filled or not.
548 void wxStyledTextCtrl::StyleSetEOLFilled(int style
, bool filled
) {
549 SendMsg(2057, style
, filled
);
552 // Reset the default style to its state at startup
553 void wxStyledTextCtrl::StyleResetDefault() {
557 // Set a style to be underlined or not.
558 void wxStyledTextCtrl::StyleSetUnderline(int style
, bool underline
) {
559 SendMsg(2059, style
, underline
);
562 // Set a style to be mixed case, or to force upper or lower case.
563 void wxStyledTextCtrl::StyleSetCase(int style
, int caseForce
) {
564 SendMsg(2060, style
, caseForce
);
567 // Set the foreground colour of the selection and whether to use this setting.
568 void wxStyledTextCtrl::SetSelForeground(bool useSetting
, const wxColour
& fore
) {
569 SendMsg(2067, useSetting
, wxColourAsLong(fore
));
572 // Set the background colour of the selection and whether to use this setting.
573 void wxStyledTextCtrl::SetSelBackground(bool useSetting
, const wxColour
& back
) {
574 SendMsg(2068, useSetting
, wxColourAsLong(back
));
577 // Set the foreground colour of the caret.
578 void wxStyledTextCtrl::SetCaretForeground(const wxColour
& fore
) {
579 SendMsg(2069, wxColourAsLong(fore
), 0);
582 // When key+modifier combination km is pressed perform msg.
583 void wxStyledTextCtrl::CmdKeyAssign(int key
, int modifiers
, int cmd
) {
584 SendMsg(2070, MAKELONG(key
, modifiers
), cmd
);
587 // When key+modifier combination km do nothing.
588 void wxStyledTextCtrl::CmdKeyClear(int key
, int modifiers
) {
589 SendMsg(2071, MAKELONG(key
, modifiers
));
592 // Drop all key mappings.
593 void wxStyledTextCtrl::CmdKeyClearAll() {
597 // Set the styles for a segment of the document.
598 void wxStyledTextCtrl::SetStyleBytes(int length
, char* styleBytes
) {
599 SendMsg(2073, length
, (long)styleBytes
);
602 // Set a style to be visible or not.
603 void wxStyledTextCtrl::StyleSetVisible(int style
, bool visible
) {
604 SendMsg(2074, style
, visible
);
607 // Get the time in milliseconds that the caret is on and off.
608 int wxStyledTextCtrl::GetCaretPeriod() {
609 return SendMsg(2075, 0, 0);
612 // Get the time in milliseconds that the caret is on and off. 0 = steady on.
613 void wxStyledTextCtrl::SetCaretPeriod(int periodMilliseconds
) {
614 SendMsg(2076, periodMilliseconds
, 0);
617 // Set the set of characters making up words for when moving or selecting
619 void wxStyledTextCtrl::SetWordChars(const wxString
& characters
) {
620 SendMsg(2077, 0, (long)characters
.c_str());
623 // Start a sequence of actions that is undone and redone as a unit.
625 void wxStyledTextCtrl::BeginUndoAction() {
629 // End a sequence of actions that is undone and redone as a unit.
630 void wxStyledTextCtrl::EndUndoAction() {
634 // Set an indicator to plain, squiggle or TT.
635 void wxStyledTextCtrl::IndicatorSetStyle(int indic
, int style
) {
636 SendMsg(2080, indic
, style
);
639 // Retrieve the style of an indicator.
640 int wxStyledTextCtrl::IndicatorGetStyle(int indic
) {
641 return SendMsg(2081, indic
, 0);
644 // Set the foreground colour of an indicator.
645 void wxStyledTextCtrl::IndicatorSetForeground(int indic
, const wxColour
& fore
) {
646 SendMsg(2082, indic
, wxColourAsLong(fore
));
649 // Retrieve the foreground colour of an indicator.
650 wxColour
wxStyledTextCtrl::IndicatorGetForeground(int indic
) {
651 long c
= SendMsg(2083, indic
, 0);
652 return wxColourFromLong(c
);
655 // Divide each styling byte into lexical class bits (default:5) and indicator
656 // bits (default:3). If a lexer requires more than 32 lexical states, then this
657 // is used to expand the possible states.
658 void wxStyledTextCtrl::SetStyleBits(int bits
) {
659 SendMsg(2090, bits
, 0);
662 // Retrieve number of bits in style bytes used to hold the lexical state.
663 int wxStyledTextCtrl::GetStyleBits() {
664 return SendMsg(2091, 0, 0);
667 // Used to hold extra styling information for each line.
668 void wxStyledTextCtrl::SetLineState(int line
, int state
) {
669 SendMsg(2092, line
, state
);
672 // Retrieve the extra styling information for a line.
673 int wxStyledTextCtrl::GetLineState(int line
) {
674 return SendMsg(2093, line
, 0);
677 // Retrieve the last line number that has line state.
678 int wxStyledTextCtrl::GetMaxLineState() {
679 return SendMsg(2094, 0, 0);
682 // Is the background of the line containing the caret in a different colour?
683 bool wxStyledTextCtrl::GetCaretLineVisible() {
684 return SendMsg(2095, 0, 0) != 0;
687 // Display the background of the line containing the caret in a different colour.
688 void wxStyledTextCtrl::SetCaretLineVisible(bool show
) {
689 SendMsg(2096, show
, 0);
692 // Get the colour of the background of the line containing the caret.
693 wxColour
wxStyledTextCtrl::GetCaretLineBack() {
694 long c
= SendMsg(2097, 0, 0);
695 return wxColourFromLong(c
);
698 // Set the colour of the background of the line containing the caret.
699 void wxStyledTextCtrl::SetCaretLineBack(const wxColour
& back
) {
700 SendMsg(2098, wxColourAsLong(back
), 0);
703 // Display a auto-completion list.
704 // The lenEntered parameter indicates how many characters before
705 // the caret should be used to provide context.
706 void wxStyledTextCtrl::AutoCompShow(int lenEntered
, const wxString
& itemList
) {
707 SendMsg(2100, lenEntered
, (long)itemList
.c_str());
710 // Remove the auto-completion list from the screen.
711 void wxStyledTextCtrl::AutoCompCancel() {
715 // Is there an auto-completion list visible?
716 bool wxStyledTextCtrl::AutoCompActive() {
717 return SendMsg(2102, 0, 0) != 0;
720 // Retrieve the position of the caret when the auto-completion list was
722 int wxStyledTextCtrl::AutoCompPosStart() {
723 return SendMsg(2103, 0, 0);
726 // User has selected an item so remove the list and insert the selection.
727 void wxStyledTextCtrl::AutoCompComplete() {
731 // Define a set of character that when typed cancel the auto-completion list.
732 void wxStyledTextCtrl::AutoCompStops(const wxString
& characterSet
) {
733 SendMsg(2105, 0, (long)characterSet
.c_str());
736 // Change the separator character in the string setting up an auto-completion
737 // list. Default is space but can be changed if items contain space.
738 void wxStyledTextCtrl::AutoCompSetSeparator(int separatorCharacter
) {
739 SendMsg(2106, separatorCharacter
, 0);
742 // Retrieve the auto-completion list separator character.
743 int wxStyledTextCtrl::AutoCompGetSeparator() {
744 return SendMsg(2107, 0, 0);
747 // Select the item in the auto-completion list that starts with a string.
748 void wxStyledTextCtrl::AutoCompSelect(const wxString
& text
) {
749 SendMsg(2108, 0, (long)text
.c_str());
752 // Should the auto-completion list be cancelled if the user backspaces to a
753 // position before where the box was created.
754 void wxStyledTextCtrl::AutoCompSetCancelAtStart(bool cancel
) {
755 SendMsg(2110, cancel
, 0);
758 // Retrieve whether auto-completion cancelled by backspacing before start.
759 bool wxStyledTextCtrl::AutoCompGetCancelAtStart() {
760 return SendMsg(2111, 0, 0) != 0;
763 // Define a set of character that when typed fills up the selected word.
764 void wxStyledTextCtrl::AutoCompSetFillUps(const wxString
& characterSet
) {
765 SendMsg(2112, 0, (long)characterSet
.c_str());
768 // Should a single item auto-completion list automatically choose the item.
769 void wxStyledTextCtrl::AutoCompSetChooseSingle(bool chooseSingle
) {
770 SendMsg(2113, chooseSingle
, 0);
773 // Retrieve whether a single item auto-completion list automatically choose the item.
774 bool wxStyledTextCtrl::AutoCompGetChooseSingle() {
775 return SendMsg(2114, 0, 0) != 0;
778 // Set whether case is significant when performing auto-completion searches.
779 void wxStyledTextCtrl::AutoCompSetIgnoreCase(bool ignoreCase
) {
780 SendMsg(2115, ignoreCase
, 0);
783 // Retrieve state of ignore case flag.
784 bool wxStyledTextCtrl::AutoCompGetIgnoreCase() {
785 return SendMsg(2116, 0, 0) != 0;
788 // Display a list of strings and send notification when user chooses one.
789 void wxStyledTextCtrl::UserListShow(int listType
, const wxString
& itemList
) {
790 SendMsg(2117, listType
, (long)itemList
.c_str());
793 // Set whether or not autocompletion is hidden automatically when nothing matches
794 void wxStyledTextCtrl::AutoCompSetAutoHide(bool autoHide
) {
795 SendMsg(2118, autoHide
, 0);
798 // Retrieve whether or not autocompletion is hidden automatically when nothing matches
799 bool wxStyledTextCtrl::AutoCompGetAutoHide() {
800 return SendMsg(2119, 0, 0) != 0;
803 // Set the number of spaces used for one level of indentation.
804 void wxStyledTextCtrl::SetIndent(int indentSize
) {
805 SendMsg(2122, indentSize
, 0);
808 // Retrieve indentation size.
809 int wxStyledTextCtrl::GetIndent() {
810 return SendMsg(2123, 0, 0);
813 // Indentation will only use space characters if useTabs is false, otherwise
814 // it will use a combination of tabs and spaces.
815 void wxStyledTextCtrl::SetUseTabs(bool useTabs
) {
816 SendMsg(2124, useTabs
, 0);
819 // Retrieve whether tabs will be used in indentation.
820 bool wxStyledTextCtrl::GetUseTabs() {
821 return SendMsg(2125, 0, 0) != 0;
824 // Change the indentation of a line to a number of columns.
825 void wxStyledTextCtrl::SetLineIndentation(int line
, int indentSize
) {
826 SendMsg(2126, line
, indentSize
);
829 // Retrieve the number of columns that a line is indented.
830 int wxStyledTextCtrl::GetLineIndentation(int line
) {
831 return SendMsg(2127, line
, 0);
834 // Retrieve the position before the first non indentation character on a line.
835 int wxStyledTextCtrl::GetLineIndentPosition(int line
) {
836 return SendMsg(2128, line
, 0);
839 // Retrieve the column number of a position, taking tab width into account.
840 int wxStyledTextCtrl::GetColumn(int pos
) {
841 return SendMsg(2129, pos
, 0);
844 // Show or hide the horizontal scroll bar.
845 void wxStyledTextCtrl::SetUseHorizontalScrollBar(bool show
) {
846 SendMsg(2130, show
, 0);
849 // Is the horizontal scroll bar visible?
850 bool wxStyledTextCtrl::GetUseHorizontalScrollBar() {
851 return SendMsg(2131, 0, 0) != 0;
854 // Show or hide indentation guides.
855 void wxStyledTextCtrl::SetIndentationGuides(bool show
) {
856 SendMsg(2132, show
, 0);
859 // Are the indentation guides visible?
860 bool wxStyledTextCtrl::GetIndentationGuides() {
861 return SendMsg(2133, 0, 0) != 0;
864 // Set the highlighted indentation guide column.
865 // 0 = no highlighted guide.
866 void wxStyledTextCtrl::SetHighlightGuide(int column
) {
867 SendMsg(2134, column
, 0);
870 // Get the highlighted indentation guide column.
871 int wxStyledTextCtrl::GetHighlightGuide() {
872 return SendMsg(2135, 0, 0);
875 // Get the position after the last visible characters on a line.
876 int wxStyledTextCtrl::GetLineEndPosition(int line
) {
877 return SendMsg(2136, line
, 0);
880 // Get the code page used to interpret the bytes of the document as characters.
881 int wxStyledTextCtrl::GetCodePage() {
882 return SendMsg(2137, 0, 0);
885 // Get the foreground colour of the caret.
886 wxColour
wxStyledTextCtrl::GetCaretForeground() {
887 long c
= SendMsg(2138, 0, 0);
888 return wxColourFromLong(c
);
891 // In read-only mode?
892 bool wxStyledTextCtrl::GetReadOnly() {
893 return SendMsg(2140, 0, 0) != 0;
896 // Sets the position of the caret.
897 void wxStyledTextCtrl::SetCurrentPos(int pos
) {
898 SendMsg(2141, pos
, 0);
901 // Sets the position that starts the selection - this becomes the anchor.
902 void wxStyledTextCtrl::SetSelectionStart(int pos
) {
903 SendMsg(2142, pos
, 0);
906 // Returns the position at the start of the selection.
907 int wxStyledTextCtrl::GetSelectionStart() {
908 return SendMsg(2143, 0, 0);
911 // Sets the position that ends the selection - this becomes the currentPosition.
912 void wxStyledTextCtrl::SetSelectionEnd(int pos
) {
913 SendMsg(2144, pos
, 0);
916 // Returns the position at the end of the selection.
917 int wxStyledTextCtrl::GetSelectionEnd() {
918 return SendMsg(2145, 0, 0);
921 // Sets the print magnification added to the point size of each style for printing.
922 void wxStyledTextCtrl::SetPrintMagnification(int magnification
) {
923 SendMsg(2146, magnification
, 0);
926 // Returns the print magnification.
927 int wxStyledTextCtrl::GetPrintMagnification() {
928 return SendMsg(2147, 0, 0);
931 // Modify colours when printing for clearer printed text.
932 void wxStyledTextCtrl::SetPrintColourMode(int mode
) {
933 SendMsg(2148, mode
, 0);
936 // Returns the print colour mode.
937 int wxStyledTextCtrl::GetPrintColourMode() {
938 return SendMsg(2149, 0, 0);
941 // Find some text in the document.
942 int wxStyledTextCtrl::FindText(int minPos
, int maxPos
,
943 const wxString
& text
,
944 bool caseSensitive
, bool wholeWord
) {
948 flags
|= caseSensitive
? SCFIND_MATCHCASE
: 0;
949 flags
|= wholeWord
? SCFIND_WHOLEWORD
: 0;
950 ft
.chrg
.cpMin
= minPos
;
951 ft
.chrg
.cpMax
= maxPos
;
952 ft
.lpstrText
= (char*)text
.c_str();
954 return SendMsg(2150, flags
, (long)&ft
);
957 // On Windows will draw the document into a display context such as a printer.
958 int wxStyledTextCtrl::FormatRange(bool doDraw
,
962 wxDC
* target
, // Why does it use two? Can they be the same?
968 fr
.hdcTarget
= target
;
969 fr
.rc
.top
= renderRect
.GetTop();
970 fr
.rc
.left
= renderRect
.GetLeft();
971 fr
.rc
.right
= renderRect
.GetRight();
972 fr
.rc
.bottom
= renderRect
.GetBottom();
973 fr
.rcPage
.top
= pageRect
.GetTop();
974 fr
.rcPage
.left
= pageRect
.GetLeft();
975 fr
.rcPage
.right
= pageRect
.GetRight();
976 fr
.rcPage
.bottom
= pageRect
.GetBottom();
977 fr
.chrg
.cpMin
= startPos
;
978 fr
.chrg
.cpMax
= endPos
;
980 return SendMsg(2151, doDraw
, (long)&fr
);
983 // Retrieve the line at the top of the display.
984 int wxStyledTextCtrl::GetFirstVisibleLine() {
985 return SendMsg(2152, 0, 0);
988 // Retrieve the contents of a line.
989 wxString
wxStyledTextCtrl::GetLine(int line
) {
991 int len
= LineLength(line
);
993 char* buf
= text
.GetWriteBuf(len
);
995 int pos
= SendMsg(2153, line
, (long)buf
);
996 text
.UngetWriteBuf(len
);
1001 // Returns the number of lines in the document. There is always at least one.
1002 int wxStyledTextCtrl::GetLineCount() {
1003 return SendMsg(2154, 0, 0);
1006 // Sets the size in pixels of the left margin.
1007 void wxStyledTextCtrl::SetMarginLeft(int pixelWidth
) {
1008 SendMsg(2155, 0, pixelWidth
);
1011 // Returns the size in pixels of the left margin.
1012 int wxStyledTextCtrl::GetMarginLeft() {
1013 return SendMsg(2156, 0, 0);
1016 // Sets the size in pixels of the right margin.
1017 void wxStyledTextCtrl::SetMarginRight(int pixelWidth
) {
1018 SendMsg(2157, 0, pixelWidth
);
1021 // Returns the size in pixels of the right margin.
1022 int wxStyledTextCtrl::GetMarginRight() {
1023 return SendMsg(2158, 0, 0);
1026 // Is the document different from when it was last saved?
1027 bool wxStyledTextCtrl::GetModify() {
1028 return SendMsg(2159, 0, 0) != 0;
1031 // Select a range of text.
1032 void wxStyledTextCtrl::SetSelection(int start
, int end
) {
1033 SendMsg(2160, start
, end
);
1036 // Retrieve the selected text.
1037 wxString
wxStyledTextCtrl::GetSelectedText() {
1042 GetSelection(&start
, &end
);
1043 int len
= end
- start
;
1044 if (!len
) return "";
1045 char* buff
= text
.GetWriteBuf(len
);
1047 SendMsg(2161, 0, (long)buff
);
1048 text
.UngetWriteBuf(len
);
1052 // Retrieve a range of text.
1053 wxString
wxStyledTextCtrl::GetTextRange(int startPos
, int endPos
) {
1055 int len
= endPos
- startPos
;
1056 if (!len
) return "";
1057 char* buff
= text
.GetWriteBuf(len
);
1059 tr
.lpstrText
= buff
;
1060 tr
.chrg
.cpMin
= startPos
;
1061 tr
.chrg
.cpMax
= endPos
;
1063 SendMsg(2162, 0, (long)&tr
);
1064 text
.UngetWriteBuf(len
);
1068 // Draw the selection in normal style or with selection highlighted.
1069 void wxStyledTextCtrl::HideSelection(bool normal
) {
1070 SendMsg(2163, normal
, 0);
1073 // Retrieve the line containing a position.
1074 int wxStyledTextCtrl::LineFromPosition(int pos
) {
1075 return SendMsg(2166, pos
, 0);
1078 // Retrieve the position at the start of a line.
1079 int wxStyledTextCtrl::PositionFromLine(int line
) {
1080 return SendMsg(2167, line
, 0);
1083 // Scroll horizontally and vertically.
1084 void wxStyledTextCtrl::LineScroll(int columns
, int lines
) {
1085 SendMsg(2168, columns
, lines
);
1088 // Ensure the caret is visible.
1089 void wxStyledTextCtrl::EnsureCaretVisible() {
1090 SendMsg(2169, 0, 0);
1093 // Replace the selected text with the argument text.
1094 void wxStyledTextCtrl::ReplaceSelection(const wxString
& text
) {
1095 SendMsg(2170, 0, (long)text
.c_str());
1098 // Set to read only or read write.
1099 void wxStyledTextCtrl::SetReadOnly(bool readOnly
) {
1100 SendMsg(2171, readOnly
, 0);
1103 // Will a paste succeed?
1104 bool wxStyledTextCtrl::CanPaste() {
1105 return SendMsg(2173, 0, 0) != 0;
1108 // Are there any undoable actions in the undo history.
1109 bool wxStyledTextCtrl::CanUndo() {
1110 return SendMsg(2174, 0, 0) != 0;
1113 // Delete the undo history.
1114 void wxStyledTextCtrl::EmptyUndoBuffer() {
1115 SendMsg(2175, 0, 0);
1118 // Undo one action in the undo history.
1119 void wxStyledTextCtrl::Undo() {
1120 SendMsg(2176, 0, 0);
1123 // Cut the selection to the clipboard.
1124 void wxStyledTextCtrl::Cut() {
1125 SendMsg(2177, 0, 0);
1128 // Copy the selection to the clipboard.
1129 void wxStyledTextCtrl::Copy() {
1130 SendMsg(2178, 0, 0);
1133 // Paste the contents of the clipboard into the document replacing the selection.
1134 void wxStyledTextCtrl::Paste() {
1135 SendMsg(2179, 0, 0);
1138 // Clear the selection.
1139 void wxStyledTextCtrl::Clear() {
1140 SendMsg(2180, 0, 0);
1143 // Replace the contents of the document with the argument text.
1144 void wxStyledTextCtrl::SetText(const wxString
& text
) {
1145 SendMsg(2181, 0, (long)text
.c_str());
1148 // Retrieve all the text in the document.
1149 wxString
wxStyledTextCtrl::GetText() {
1151 int len
= GetTextLength();
1152 char* buff
= text
.GetWriteBuf(len
+1); // leave room for the null...
1154 SendMsg(2182, len
+1, (long)buff
);
1155 text
.UngetWriteBuf(len
);
1159 // Retrieve the number of characters in the document.
1160 int wxStyledTextCtrl::GetTextLength() {
1161 return SendMsg(2183, 0, 0);
1164 // Set to overtype (true) or insert mode
1165 void wxStyledTextCtrl::SetOvertype(bool overtype
) {
1166 SendMsg(2186, overtype
, 0);
1169 // Returns true if overtype mode is active otherwise false is returned.
1170 bool wxStyledTextCtrl::GetOvertype() {
1171 return SendMsg(2187, 0, 0) != 0;
1174 // Set the width of the insert mode caret
1175 void wxStyledTextCtrl::SetCaretWidth(int pixelWidth
) {
1176 SendMsg(2188, pixelWidth
, 0);
1179 // Returns the width of the insert mode caret
1180 int wxStyledTextCtrl::GetCaretWidth() {
1181 return SendMsg(2189, 0, 0);
1184 // Sets the position that starts the target which is used for updating the
1185 // document without affecting the scroll position.
1186 void wxStyledTextCtrl::SetTargetStart(int pos
) {
1187 SendMsg(2190, pos
, 0);
1190 // Get the position that starts the target.
1191 int wxStyledTextCtrl::GetTargetStart() {
1192 return SendMsg(2191, 0, 0);
1195 // Sets the position that ends the target which is used for updating the
1196 // document without affecting the scroll position.
1197 void wxStyledTextCtrl::SetTargetEnd(int pos
) {
1198 SendMsg(2192, pos
, 0);
1201 // Get the position that ends the target.
1202 int wxStyledTextCtrl::GetTargetEnd() {
1203 return SendMsg(2193, 0, 0);
1206 // Replace the target text with the argument text.
1207 // Text is counted so it can contain nulls.
1208 // Returns the length of the replacement text.
1210 int wxStyledTextCtrl::ReplaceTarget(const wxString
& text
) {
1211 return SendMsg(2194, text
.Len(), (long)text
.c_str());
1215 // Replace the target text with the argument text after \d processing.
1216 // Text is counted so it can contain nulls.
1217 // Looks for \d where d is between 1 and 9 and replaces these with the strings
1218 // matched in the last search operation which were surrounded by \( and \).
1219 // Returns the length of the replacement text including any change
1220 // caused by processing the \d patterns.
1222 int wxStyledTextCtrl::ReplaceTargetRE(const wxString
& text
) {
1223 return SendMsg(2195, text
.Len(), (long)text
.c_str());
1227 // Search for a counted string in the target and set the target to the found
1228 // range. Text is counted so it can contain nulls.
1229 // Returns length of range or -1 for failure in which case target is not moved.
1231 int wxStyledTextCtrl::SearchInTarget(const wxString
& text
) {
1232 return SendMsg(2197, text
.Len(), (long)text
.c_str());
1236 // Set the search flags used by SearchInTarget
1237 void wxStyledTextCtrl::SetSearchFlags(int flags
) {
1238 SendMsg(2198, flags
, 0);
1241 // Get the search flags used by SearchInTarget
1242 int wxStyledTextCtrl::GetSearchFlags() {
1243 return SendMsg(2199, 0, 0);
1246 // Show a call tip containing a definition near position pos.
1247 void wxStyledTextCtrl::CallTipShow(int pos
, const wxString
& definition
) {
1248 SendMsg(2200, pos
, (long)definition
.c_str());
1251 // Remove the call tip from the screen.
1252 void wxStyledTextCtrl::CallTipCancel() {
1253 SendMsg(2201, 0, 0);
1256 // Is there an active call tip?
1257 bool wxStyledTextCtrl::CallTipActive() {
1258 return SendMsg(2202, 0, 0) != 0;
1261 // Retrieve the position where the caret was before displaying the call tip.
1262 int wxStyledTextCtrl::CallTipPosAtStart() {
1263 return SendMsg(2203, 0, 0);
1266 // Highlight a segment of the definition.
1267 void wxStyledTextCtrl::CallTipSetHighlight(int start
, int end
) {
1268 SendMsg(2204, start
, end
);
1271 // Set the background colour for the call tip.
1272 void wxStyledTextCtrl::CallTipSetBackground(const wxColour
& back
) {
1273 SendMsg(2205, wxColourAsLong(back
), 0);
1276 // Find the display line of a document line taking hidden lines into account.
1277 int wxStyledTextCtrl::VisibleFromDocLine(int line
) {
1278 return SendMsg(2220, line
, 0);
1281 // Find the document line of a display line taking hidden lines into account.
1282 int wxStyledTextCtrl::DocLineFromVisible(int lineDisplay
) {
1283 return SendMsg(2221, lineDisplay
, 0);
1286 // Set the fold level of a line.
1287 // This encodes an integer level along with flags indicating whether the
1288 // line is a header and whether it is effectively white space.
1289 void wxStyledTextCtrl::SetFoldLevel(int line
, int level
) {
1290 SendMsg(2222, line
, level
);
1293 // Retrieve the fold level of a line.
1294 int wxStyledTextCtrl::GetFoldLevel(int line
) {
1295 return SendMsg(2223, line
, 0);
1298 // Find the last child line of a header line.
1299 int wxStyledTextCtrl::GetLastChild(int line
, int level
) {
1300 return SendMsg(2224, line
, level
);
1303 // Find the parent line of a child line.
1304 int wxStyledTextCtrl::GetFoldParent(int line
) {
1305 return SendMsg(2225, line
, 0);
1308 // Make a range of lines visible.
1309 void wxStyledTextCtrl::ShowLines(int lineStart
, int lineEnd
) {
1310 SendMsg(2226, lineStart
, lineEnd
);
1313 // Make a range of lines invisible.
1314 void wxStyledTextCtrl::HideLines(int lineStart
, int lineEnd
) {
1315 SendMsg(2227, lineStart
, lineEnd
);
1318 // Is a line visible?
1319 bool wxStyledTextCtrl::GetLineVisible(int line
) {
1320 return SendMsg(2228, line
, 0) != 0;
1323 // Show the children of a header line.
1324 void wxStyledTextCtrl::SetFoldExpanded(int line
, bool expanded
) {
1325 SendMsg(2229, line
, expanded
);
1328 // Is a header line expanded?
1329 bool wxStyledTextCtrl::GetFoldExpanded(int line
) {
1330 return SendMsg(2230, line
, 0) != 0;
1333 // Switch a header line between expanded and contracted.
1334 void wxStyledTextCtrl::ToggleFold(int line
) {
1335 SendMsg(2231, line
, 0);
1338 // Ensure a particular line is visible by expanding any header line hiding it.
1339 void wxStyledTextCtrl::EnsureVisible(int line
) {
1340 SendMsg(2232, line
, 0);
1343 // Set some debugging options for folding
1344 void wxStyledTextCtrl::SetFoldFlags(int flags
) {
1345 SendMsg(2233, flags
, 0);
1348 // Ensure a particular line is visible by expanding any header line hiding it.
1349 // Use the currently set visibility policy to determine which range to display.
1350 void wxStyledTextCtrl::EnsureVisibleEnforcePolicy(int line
) {
1351 SendMsg(2234, line
, 0);
1354 // Sets whether a tab pressed when caret is within indentation indents
1355 void wxStyledTextCtrl::SetTabIndents(bool tabIndents
) {
1356 SendMsg(2260, tabIndents
, 0);
1359 // Does a tab pressed when caret is within indentation indent?
1360 bool wxStyledTextCtrl::GetTabIndents() {
1361 return SendMsg(2261, 0, 0) != 0;
1364 // Sets whether a backspace pressed when caret is within indentation unindents
1365 void wxStyledTextCtrl::SetBackSpaceUnIndents(bool bsUnIndents
) {
1366 SendMsg(2262, bsUnIndents
, 0);
1369 // Does a backspace pressed when caret is within indentation unindent?
1370 bool wxStyledTextCtrl::GetBackSpaceUnIndents() {
1371 return SendMsg(2263, 0, 0) != 0;
1374 // Sets the time the mouse must sit still to generate a mouse dwell event
1375 void wxStyledTextCtrl::SetMouseDwellTime(int periodMilliseconds
) {
1376 SendMsg(2264, periodMilliseconds
, 0);
1379 // Retrieve the time the mouse must sit still to generate a mouse dwell event
1380 int wxStyledTextCtrl::GetMouseDwellTime() {
1381 return SendMsg(2265, 0, 0);
1384 // Move the caret inside current view if it's not there already
1385 void wxStyledTextCtrl::MoveCaretInsideView() {
1386 SendMsg(2401, 0, 0);
1389 // How many characters are on a line, not including end of line characters.
1390 int wxStyledTextCtrl::LineLength(int line
) {
1391 return SendMsg(2350, line
, 0);
1394 // Highlight the characters at two positions.
1395 void wxStyledTextCtrl::BraceHighlight(int pos1
, int pos2
) {
1396 SendMsg(2351, pos1
, pos2
);
1399 // Highlight the character at a position indicating there is no matching brace.
1400 void wxStyledTextCtrl::BraceBadLight(int pos
) {
1401 SendMsg(2352, pos
, 0);
1404 // Find the position of a matching brace or INVALID_POSITION if no match.
1405 int wxStyledTextCtrl::BraceMatch(int pos
) {
1406 return SendMsg(2353, pos
, 0);
1409 // Are the end of line characters visible.
1410 bool wxStyledTextCtrl::GetViewEOL() {
1411 return SendMsg(2355, 0, 0) != 0;
1414 // Make the end of line characters visible or invisible
1415 void wxStyledTextCtrl::SetViewEOL(bool visible
) {
1416 SendMsg(2356, visible
, 0);
1419 // Retrieve a pointer to the document object.
1420 void* wxStyledTextCtrl::GetDocPointer() {
1421 return (void*)SendMsg(2357);
1424 // Change the document object used.
1425 void wxStyledTextCtrl::SetDocPointer(void* docPointer
) {
1426 SendMsg(2358, 0, (long)docPointer
);
1429 // Set which document modification events are sent to the container.
1430 void wxStyledTextCtrl::SetModEventMask(int mask
) {
1431 SendMsg(2359, mask
, 0);
1434 // Retrieve the column number which text should be kept within.
1435 int wxStyledTextCtrl::GetEdgeColumn() {
1436 return SendMsg(2360, 0, 0);
1439 // Set the column number of the edge.
1440 // If text goes past the edge then it is highlighted.
1441 void wxStyledTextCtrl::SetEdgeColumn(int column
) {
1442 SendMsg(2361, column
, 0);
1445 // Retrieve the edge highlight mode.
1446 int wxStyledTextCtrl::GetEdgeMode() {
1447 return SendMsg(2362, 0, 0);
1450 // The edge may be displayed by a line (EDGE_LINE) or by highlighting text that
1451 // goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
1452 void wxStyledTextCtrl::SetEdgeMode(int mode
) {
1453 SendMsg(2363, mode
, 0);
1456 // Retrieve the colour used in edge indication.
1457 wxColour
wxStyledTextCtrl::GetEdgeColour() {
1458 long c
= SendMsg(2364, 0, 0);
1459 return wxColourFromLong(c
);
1462 // Change the colour used in edge indication.
1463 void wxStyledTextCtrl::SetEdgeColour(const wxColour
& edgeColour
) {
1464 SendMsg(2365, wxColourAsLong(edgeColour
), 0);
1467 // Sets the current caret position to be the search anchor.
1468 void wxStyledTextCtrl::SearchAnchor() {
1469 SendMsg(2366, 0, 0);
1472 // Find some text starting at the search anchor.
1473 // Does not ensure the selection is visible.
1474 int wxStyledTextCtrl::SearchNext(int flags
, const wxString
& text
) {
1475 return SendMsg(2367, flags
, (long)text
.c_str());
1478 // Find some text starting at the search anchor and moving backwards.
1479 // Does not ensure the selection is visible.
1480 int wxStyledTextCtrl::SearchPrev(int flags
, const wxString
& text
) {
1481 return SendMsg(2368, flags
, (long)text
.c_str());
1484 // Set the way the line the caret is on is kept visible.
1485 void wxStyledTextCtrl::SetCaretPolicy(int caretPolicy
, int caretSlop
) {
1486 SendMsg(2369, caretPolicy
, caretSlop
);
1489 // Retrieves the number of lines completely visible.
1490 int wxStyledTextCtrl::LinesOnScreen() {
1491 return SendMsg(2370, 0, 0);
1494 // Set whether a pop up menu is displayed automatically when the user presses
1495 // the wrong mouse button.
1496 void wxStyledTextCtrl::UsePopUp(bool allowPopUp
) {
1497 SendMsg(2371, allowPopUp
, 0);
1500 // Is the selection a rectangular. The alternative is the more common stream selection.
1501 bool wxStyledTextCtrl::SelectionIsRectangle() {
1502 return SendMsg(2372, 0, 0) != 0;
1505 // Set the zoom level. This number of points is added to the size of all fonts.
1506 // It may be positive to magnify or negative to reduce.
1507 void wxStyledTextCtrl::SetZoom(int zoom
) {
1508 SendMsg(2373, zoom
, 0);
1511 // Retrieve the zoom level.
1512 int wxStyledTextCtrl::GetZoom() {
1513 return SendMsg(2374, 0, 0);
1516 // Create a new document object.
1517 // Starts with reference count of 1 and not selected into editor.
1518 void* wxStyledTextCtrl::CreateDocument() {
1519 return (void*)SendMsg(2375);
1522 // Extend life of document.
1523 void wxStyledTextCtrl::AddRefDocument(void* docPointer
) {
1524 SendMsg(2376, (long)docPointer
);
1527 // Release a reference to the document, deleting document if it fades to black.
1528 void wxStyledTextCtrl::ReleaseDocument(void* docPointer
) {
1529 SendMsg(2377, (long)docPointer
);
1532 // Get which document modification events are sent to the container.
1533 int wxStyledTextCtrl::GetModEventMask() {
1534 return SendMsg(2378, 0, 0);
1537 // Change internal focus flag
1538 void wxStyledTextCtrl::SetSTCFocus(bool focus
) {
1539 SendMsg(2380, focus
, 0);
1542 // Get internal focus flag
1543 bool wxStyledTextCtrl::GetSTCFocus() {
1544 return SendMsg(2381, 0, 0) != 0;
1547 // Change error status - 0 = OK
1548 void wxStyledTextCtrl::SetStatus(int statusCode
) {
1549 SendMsg(2382, statusCode
, 0);
1553 int wxStyledTextCtrl::GetStatus() {
1554 return SendMsg(2383, 0, 0);
1557 // Set whether the mouse is captured when its button is pressed
1558 void wxStyledTextCtrl::SetMouseDownCaptures(bool captures
) {
1559 SendMsg(2384, captures
, 0);
1562 // Get whether mouse gets captured
1563 bool wxStyledTextCtrl::GetMouseDownCaptures() {
1564 return SendMsg(2385, 0, 0) != 0;
1567 // Sets the cursor to one of the SC_CURSOR* values
1568 void wxStyledTextCtrl::SetCursor(int cursorType
) {
1569 SendMsg(2386, cursorType
, 0);
1573 int wxStyledTextCtrl::GetCursor() {
1574 return SendMsg(2387, 0, 0);
1577 // Move to the previous change in capitalistion
1578 void wxStyledTextCtrl::WordPartLeft() {
1579 SendMsg(2390, 0, 0);
1582 // Move to the previous change in capitalistion extending selection to new caret position.
1583 void wxStyledTextCtrl::WordPartLeftExtend() {
1584 SendMsg(2391, 0, 0);
1587 // Move to the change next in capitalistion
1588 void wxStyledTextCtrl::WordPartRight() {
1589 SendMsg(2392, 0, 0);
1592 // Move to the next change in capitalistion extending selection to new caret position.
1593 void wxStyledTextCtrl::WordPartRightExtend() {
1594 SendMsg(2393, 0, 0);
1597 // Set the way the display area is determined when a particular line is to be moved to.
1598 void wxStyledTextCtrl::SetVisiblePolicy(int visiblePolicy
, int visibleSlop
) {
1599 SendMsg(2394, visiblePolicy
, visibleSlop
);
1602 // Delete back from the current position to the start of the line
1603 void wxStyledTextCtrl::DelLineLeft() {
1604 SendMsg(2395, 0, 0);
1607 // Delete forwards from the current position to the end of the line
1608 void wxStyledTextCtrl::DelLineRight() {
1609 SendMsg(2396, 0, 0);
1612 // Start notifying the container of all key presses and commands.
1613 void wxStyledTextCtrl::StartRecord() {
1614 SendMsg(3001, 0, 0);
1617 // Stop notifying the container of all key presses and commands.
1618 void wxStyledTextCtrl::StopRecord() {
1619 SendMsg(3002, 0, 0);
1622 // Set the lexing language of the document.
1623 void wxStyledTextCtrl::SetLexer(int lexer
) {
1624 SendMsg(4001, lexer
, 0);
1627 // Retrieve the lexing language of the document.
1628 int wxStyledTextCtrl::GetLexer() {
1629 return SendMsg(4002, 0, 0);
1632 // Colourise a segment of the document using the current lexing language.
1633 void wxStyledTextCtrl::Colourise(int start
, int end
) {
1634 SendMsg(4003, start
, end
);
1637 // Set up a value that may be used by a lexer for some optional feature.
1638 void wxStyledTextCtrl::SetProperty(const wxString
& key
, const wxString
& value
) {
1639 SendMsg(4004, (long)key
.c_str(), (long)value
.c_str());
1642 // Set up the key words used by the lexer.
1643 void wxStyledTextCtrl::SetKeyWords(int keywordSet
, const wxString
& keyWords
) {
1644 SendMsg(4005, keywordSet
, (long)keyWords
.c_str());
1647 // Set the lexing language of the document based on string name.
1648 void wxStyledTextCtrl::SetLexerLanguage(const wxString
& language
) {
1649 SendMsg(4006, 0, (long)language
.c_str());
1652 // END of generated section
1653 //----------------------------------------------------------------------
1656 // Returns the line number of the line with the caret.
1657 int wxStyledTextCtrl::GetCurrentLine() {
1658 int line
= LineFromPosition(GetCurrentPos());
1663 // Extract style settings from a spec-string which is composed of one or
1664 // more of the following comma separated elements:
1666 // bold turns on bold
1667 // italic turns on italics
1668 // fore:#RRGGBB sets the foreground colour
1669 // back:#RRGGBB sets the background colour
1670 // face:[facename] sets the font face name to use
1671 // size:[num] sets the font size in points
1672 // eol turns on eol filling
1673 // underline turns on underlining
1675 void wxStyledTextCtrl::StyleSetSpec(int styleNum
, const wxString
& spec
) {
1677 wxStringTokenizer
tkz(spec
, ",");
1678 while (tkz
.HasMoreTokens()) {
1679 wxString token
= tkz
.GetNextToken();
1681 wxString option
= token
.BeforeFirst(':');
1682 wxString val
= token
.AfterFirst(':');
1684 if (option
== "bold")
1685 StyleSetBold(styleNum
, true);
1687 else if (option
== "italic")
1688 StyleSetItalic(styleNum
, true);
1690 else if (option
== "underline")
1691 StyleSetUnderline(styleNum
, true);
1693 else if (option
== "eol")
1694 StyleSetEOLFilled(styleNum
, true);
1696 else if (option
== "size") {
1698 if (val
.ToLong(&points
))
1699 StyleSetSize(styleNum
, points
);
1702 else if (option
== "face")
1703 StyleSetFaceName(styleNum
, val
);
1705 else if (option
== "fore")
1706 StyleSetForeground(styleNum
, wxColourFromSpec(val
));
1708 else if (option
== "back")
1709 StyleSetBackground(styleNum
, wxColourFromSpec(val
));
1714 // Set style size, face, bold, italic, and underline attributes from
1715 // a wxFont's attributes.
1716 void wxStyledTextCtrl::StyleSetFont(int styleNum
, wxFont
& font
) {
1717 int size
= font
.GetPointSize();
1718 wxString faceName
= font
.GetFaceName();
1719 bool bold
= font
.GetWeight() == wxBOLD
;
1720 bool italic
= font
.GetStyle() != wxNORMAL
;
1721 bool under
= font
.GetUnderlined();
1723 // TODO: add encoding/charset mapping
1724 StyleSetFontAttr(styleNum
, size
, faceName
, bold
, italic
, under
);
1727 // Set all font style attributes at once.
1728 void wxStyledTextCtrl::StyleSetFontAttr(int styleNum
, int size
,
1729 const wxString
& faceName
,
1730 bool bold
, bool italic
,
1732 StyleSetSize(styleNum
, size
);
1733 StyleSetFaceName(styleNum
, faceName
);
1734 StyleSetBold(styleNum
, bold
);
1735 StyleSetItalic(styleNum
, italic
);
1736 StyleSetUnderline(styleNum
, underline
);
1738 // TODO: add encoding/charset mapping
1742 // Perform one of the operations defined by the wxSTC_CMD_* constants.
1743 void wxStyledTextCtrl::CmdKeyExecute(int cmd
) {
1748 // Set the left and right margin in the edit area, measured in pixels.
1749 void wxStyledTextCtrl::SetMargins(int left
, int right
) {
1750 SetMarginLeft(left
);
1751 SetMarginRight(right
);
1755 // Retrieve the start and end positions of the current selection.
1756 void wxStyledTextCtrl::GetSelection(int* startPos
, int* endPos
) {
1757 if (startPos
!= NULL
)
1758 *startPos
= SendMsg(SCI_GETSELECTIONSTART
);
1760 *endPos
= SendMsg(SCI_GETSELECTIONEND
);
1764 // Retrieve the point in the window where a position is displayed.
1765 wxPoint
wxStyledTextCtrl::PointFromPosition(int pos
) {
1766 int x
= SendMsg(SCI_POINTXFROMPOSITION
, 0, pos
);
1767 int y
= SendMsg(SCI_POINTYFROMPOSITION
, 0, pos
);
1768 return wxPoint(x
, y
);
1771 // Scroll enough to make the given line visible
1772 void wxStyledTextCtrl::ScrollToLine(int line
) {
1773 m_swx
->DoScrollToLine(line
);
1777 // Scroll enough to make the given column visible
1778 void wxStyledTextCtrl::ScrollToColumn(int column
) {
1779 m_swx
->DoScrollToColumn(column
);
1784 //----------------------------------------------------------------------
1787 void wxStyledTextCtrl::OnPaint(wxPaintEvent
& evt
) {
1789 wxRegion region
= GetUpdateRegion();
1791 m_swx
->DoPaint(&dc
, region
.GetBox());
1794 void wxStyledTextCtrl::OnScrollWin(wxScrollWinEvent
& evt
) {
1795 if (evt
.GetOrientation() == wxHORIZONTAL
)
1796 m_swx
->DoHScroll(evt
.GetEventType(), evt
.GetPosition());
1798 m_swx
->DoVScroll(evt
.GetEventType(), evt
.GetPosition());
1801 void wxStyledTextCtrl::OnSize(wxSizeEvent
& evt
) {
1802 wxSize sz
= GetClientSize();
1803 m_swx
->DoSize(sz
.x
, sz
.y
);
1806 void wxStyledTextCtrl::OnMouseLeftDown(wxMouseEvent
& evt
) {
1807 wxPoint pt
= evt
.GetPosition();
1808 m_swx
->DoButtonDown(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
1809 evt
.ShiftDown(), evt
.ControlDown(), evt
.AltDown());
1812 void wxStyledTextCtrl::OnMouseMove(wxMouseEvent
& evt
) {
1813 wxPoint pt
= evt
.GetPosition();
1814 m_swx
->DoButtonMove(Point(pt
.x
, pt
.y
));
1817 void wxStyledTextCtrl::OnMouseLeftUp(wxMouseEvent
& evt
) {
1818 wxPoint pt
= evt
.GetPosition();
1819 m_swx
->DoButtonUp(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
1824 void wxStyledTextCtrl::OnContextMenu(wxContextMenuEvent
& evt
) {
1825 wxPoint pt
= evt
.GetPosition();
1826 ScreenToClient(&pt
.x
, &pt
.y
);
1827 m_swx
->DoContextMenu(Point(pt
.x
, pt
.y
));
1831 void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent
& evt
) {
1832 m_swx
->DoMouseWheel(evt
.GetWheelRotation(),
1833 evt
.GetWheelDelta(),
1834 evt
.GetLinesPerAction(),
1839 void wxStyledTextCtrl::OnChar(wxKeyEvent
& evt
) {
1840 long key
= evt
.KeyCode();
1842 // printf("OnChar key:%d consumed:%d ctrl:%d alt:%d\n",
1843 // key, m_lastKeyDownConsumed, evt.ControlDown(), evt.AltDown());
1846 // \|@#¬[]{}?£$~ ã,õ,Ã,Õ, ñ, Ñ
1848 // On (some?) non-US keyboards the AltGr key is required to enter some
1849 // common characters. It comes to us as both Alt and Ctrl down so we need
1850 // to let the char through in that case, otherwise if only ctrl or only
1851 // alt let's skip it.
1852 bool ctrl
= evt
.ControlDown();
1853 bool alt
= evt
.AltDown();
1854 bool skip
= (ctrl
|| alt
&& ! (ctrl
&& alt
));
1856 if (key
<= 0xff && !iscntrl(key
) && !m_lastKeyDownConsumed
&& !skip
) {
1857 m_swx
->DoAddChar(key
);
1864 void wxStyledTextCtrl::OnKeyDown(wxKeyEvent
& evt
) {
1865 long key
= evt
.KeyCode();
1866 bool shift
= evt
.ShiftDown(),
1867 ctrl
= evt
.ControlDown(),
1868 alt
= evt
.AltDown();
1870 int processed
= m_swx
->DoKeyDown(key
, shift
, ctrl
, alt
, &m_lastKeyDownConsumed
);
1872 // printf("key: %d shift: %d ctrl: %d alt: %d processed: %d consumed: %d\n",
1873 // key, shift, ctrl, alt, processed, m_lastKeyDownConsumed);
1875 if (!processed
&& !m_lastKeyDownConsumed
)
1880 void wxStyledTextCtrl::OnLoseFocus(wxFocusEvent
& evt
) {
1881 m_swx
->DoLoseFocus();
1885 void wxStyledTextCtrl::OnGainFocus(wxFocusEvent
& evt
) {
1886 m_swx
->DoGainFocus();
1890 void wxStyledTextCtrl::OnSysColourChanged(wxSysColourChangedEvent
& evt
) {
1891 m_swx
->DoSysColourChange();
1895 void wxStyledTextCtrl::OnEraseBackground(wxEraseEvent
& evt
) {
1896 // do nothing to help avoid flashing
1901 void wxStyledTextCtrl::OnMenu(wxCommandEvent
& evt
) {
1902 m_swx
->DoCommand(evt
.GetId());
1906 void wxStyledTextCtrl::OnListBox(wxCommandEvent
& evt
) {
1907 m_swx
->DoOnListBox();
1911 //----------------------------------------------------------------------
1912 // Turn notifications from Scintilla into events
1915 void wxStyledTextCtrl::NotifyChange() {
1916 wxStyledTextEvent
evt(wxEVT_STC_CHANGE
, GetId());
1917 GetEventHandler()->ProcessEvent(evt
);
1920 void wxStyledTextCtrl::NotifyParent(SCNotification
* _scn
) {
1921 SCNotification
& scn
= *_scn
;
1922 wxStyledTextEvent
evt(0, GetId());
1924 evt
.SetPosition(scn
.position
);
1926 evt
.SetModifiers(scn
.modifiers
);
1928 switch (scn
.nmhdr
.code
) {
1929 case SCN_STYLENEEDED
:
1930 evt
.SetEventType(wxEVT_STC_STYLENEEDED
);
1934 evt
.SetEventType(wxEVT_STC_CHARADDED
);
1937 case SCN_SAVEPOINTREACHED
:
1938 evt
.SetEventType(wxEVT_STC_SAVEPOINTREACHED
);
1941 case SCN_SAVEPOINTLEFT
:
1942 evt
.SetEventType(wxEVT_STC_SAVEPOINTLEFT
);
1945 case SCN_MODIFYATTEMPTRO
:
1946 evt
.SetEventType(wxEVT_STC_ROMODIFYATTEMPT
);
1950 evt
.SetEventType(wxEVT_STC_KEY
);
1953 case SCN_DOUBLECLICK
:
1954 evt
.SetEventType(wxEVT_STC_DOUBLECLICK
);
1958 evt
.SetEventType(wxEVT_STC_UPDATEUI
);
1962 evt
.SetEventType(wxEVT_STC_MODIFIED
);
1963 evt
.SetModificationType(scn
.modificationType
);
1965 evt
.SetText(wxString(scn
.text
, scn
.length
));
1966 evt
.SetLength(scn
.length
);
1967 evt
.SetLinesAdded(scn
.linesAdded
);
1968 evt
.SetLine(scn
.line
);
1969 evt
.SetFoldLevelNow(scn
.foldLevelNow
);
1970 evt
.SetFoldLevelPrev(scn
.foldLevelPrev
);
1973 case SCN_MACRORECORD
:
1974 evt
.SetEventType(wxEVT_STC_MACRORECORD
);
1975 evt
.SetMessage(scn
.message
);
1976 evt
.SetWParam(scn
.wParam
);
1977 evt
.SetLParam(scn
.lParam
);
1980 case SCN_MARGINCLICK
:
1981 evt
.SetEventType(wxEVT_STC_MARGINCLICK
);
1982 evt
.SetMargin(scn
.margin
);
1986 evt
.SetEventType(wxEVT_STC_NEEDSHOWN
);
1987 evt
.SetLength(scn
.length
);
1990 case SCN_POSCHANGED
:
1991 evt
.SetEventType(wxEVT_STC_POSCHANGED
);
1995 evt
.SetEventType(wxEVT_STC_PAINTED
);
1998 case SCN_USERLISTSELECTION
:
1999 evt
.SetEventType(wxEVT_STC_USERLISTSELECTION
);
2000 evt
.SetListType(scn
.listType
);
2001 evt
.SetText(scn
.text
);
2004 case SCN_URIDROPPED
:
2005 evt
.SetEventType(wxEVT_STC_URIDROPPED
);
2006 evt
.SetText(scn
.text
);
2009 case SCN_DWELLSTART
:
2010 evt
.SetEventType(wxEVT_STC_DWELLSTART
);
2016 evt
.SetEventType(wxEVT_STC_DWELLEND
);
2025 GetEventHandler()->ProcessEvent(evt
);
2030 //----------------------------------------------------------------------
2031 //----------------------------------------------------------------------
2032 //----------------------------------------------------------------------
2034 wxStyledTextEvent::wxStyledTextEvent(wxEventType commandType
, int id
)
2035 : wxCommandEvent(commandType
, id
)
2040 m_modificationType
= 0;
2045 m_foldLevelPrev
= 0;
2055 bool wxStyledTextEvent::GetShift() const { return (m_modifiers
& SCI_SHIFT
) != 0; }
2056 bool wxStyledTextEvent::GetControl() const { return (m_modifiers
& SCI_CTRL
) != 0; }
2057 bool wxStyledTextEvent::GetAlt() const { return (m_modifiers
& SCI_ALT
) != 0; }
2059 void wxStyledTextEvent::CopyObject(wxObject
& obj
) const {
2060 wxCommandEvent::CopyObject(obj
);
2062 wxStyledTextEvent
* o
= (wxStyledTextEvent
*)&obj
;
2063 o
->m_position
= m_position
;
2065 o
->m_modifiers
= m_modifiers
;
2066 o
->m_modificationType
= m_modificationType
;
2068 o
->m_length
= m_length
;
2069 o
->m_linesAdded
= m_linesAdded
;
2071 o
->m_foldLevelNow
= m_foldLevelNow
;
2072 o
->m_foldLevelPrev
= m_foldLevelPrev
;
2074 o
->m_margin
= m_margin
;
2076 o
->m_message
= m_message
;
2077 o
->m_wParam
= m_wParam
;
2078 o
->m_lParam
= m_lParam
;
2080 o
->m_listType
= m_listType
;
2086 //----------------------------------------------------------------------
2087 //----------------------------------------------------------------------