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