1 ////////////////////////////////////////////////////////////////////////////
3 // Purpose: A wxWindows implementation of Scintilla. This class is the
4 // one meant to be used directly by wx applications. It does not
5 // derive directly from the Scintilla classes, but instead
6 // delegates most things to the real Scintilla class.
7 // This allows the use of Scintilla without polluting the
8 // namespace with all the classes and identifiers from Scintilla.
12 // Created: 13-Jan-2000
14 // Copyright: (c) 2000 by Total Control Software
15 // Licence: wxWindows license
16 /////////////////////////////////////////////////////////////////////////////
20 #include "wx/stc/stc.h"
21 #include "ScintillaWX.h"
23 #include <wx/tokenzr.h>
25 // The following code forces a reference to all of the Scintilla lexers.
26 // If we don't do something like this, then the linker tends to "optimize"
27 // them away. (eric@sourcegear.com)
29 int wxForceScintillaLexers(void)
31 extern LexerModule lmAda
;
32 extern LexerModule lmAVE
;
33 extern LexerModule lmConf
;
34 extern LexerModule lmCPP
;
35 extern LexerModule lmEiffel
;
36 extern LexerModule lmHTML
;
37 extern LexerModule lmLISP
;
38 extern LexerModule lmLua
;
39 extern LexerModule lmBatch
; // In LexOthers.cxx
40 extern LexerModule lmPascal
;
41 extern LexerModule lmPerl
;
42 extern LexerModule lmPython
;
43 extern LexerModule lmRuby
;
44 extern LexerModule lmSQL
;
45 extern LexerModule lmVB
;
71 //----------------------------------------------------------------------
73 const wxChar
* wxSTCNameStr
= "stcwindow";
75 DEFINE_EVENT_TYPE( wxEVT_STC_CHANGE
)
76 DEFINE_EVENT_TYPE( wxEVT_STC_STYLENEEDED
)
77 DEFINE_EVENT_TYPE( wxEVT_STC_CHARADDED
)
78 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTREACHED
)
79 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTLEFT
)
80 DEFINE_EVENT_TYPE( wxEVT_STC_ROMODIFYATTEMPT
)
81 DEFINE_EVENT_TYPE( wxEVT_STC_KEY
)
82 DEFINE_EVENT_TYPE( wxEVT_STC_DOUBLECLICK
)
83 DEFINE_EVENT_TYPE( wxEVT_STC_UPDATEUI
)
84 DEFINE_EVENT_TYPE( wxEVT_STC_MODIFIED
)
85 DEFINE_EVENT_TYPE( wxEVT_STC_MACRORECORD
)
86 DEFINE_EVENT_TYPE( wxEVT_STC_MARGINCLICK
)
87 DEFINE_EVENT_TYPE( wxEVT_STC_NEEDSHOWN
)
88 DEFINE_EVENT_TYPE( wxEVT_STC_POSCHANGED
)
89 DEFINE_EVENT_TYPE( wxEVT_STC_PAINTED
)
90 DEFINE_EVENT_TYPE( wxEVT_STC_USERLISTSELECTION
)
91 DEFINE_EVENT_TYPE( wxEVT_STC_URIDROPPED
)
92 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLSTART
)
93 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLEND
)
98 BEGIN_EVENT_TABLE(wxStyledTextCtrl
, wxControl
)
99 EVT_PAINT (wxStyledTextCtrl::OnPaint
)
100 EVT_SCROLLWIN (wxStyledTextCtrl::OnScrollWin
)
101 EVT_SIZE (wxStyledTextCtrl::OnSize
)
102 EVT_LEFT_DOWN (wxStyledTextCtrl::OnMouseLeftDown
)
104 // Let Scintilla see the double click as a second click
105 EVT_LEFT_DCLICK (wxStyledTextCtrl::OnMouseLeftDown
)
107 EVT_MOTION (wxStyledTextCtrl::OnMouseMove
)
108 EVT_LEFT_UP (wxStyledTextCtrl::OnMouseLeftUp
)
109 EVT_CONTEXT_MENU (wxStyledTextCtrl::OnContextMenu
)
110 EVT_MOUSEWHEEL (wxStyledTextCtrl::OnMouseWheel
)
111 EVT_CHAR (wxStyledTextCtrl::OnChar
)
112 EVT_KEY_DOWN (wxStyledTextCtrl::OnKeyDown
)
113 EVT_KILL_FOCUS (wxStyledTextCtrl::OnLoseFocus
)
114 EVT_SET_FOCUS (wxStyledTextCtrl::OnGainFocus
)
115 EVT_SYS_COLOUR_CHANGED (wxStyledTextCtrl::OnSysColourChanged
)
116 EVT_ERASE_BACKGROUND (wxStyledTextCtrl::OnEraseBackground
)
117 EVT_MENU_RANGE (-1, -1, wxStyledTextCtrl::OnMenu
)
118 EVT_LISTBOX_DCLICK (-1, wxStyledTextCtrl::OnListBox
)
122 IMPLEMENT_CLASS(wxStyledTextCtrl
, wxControl
)
123 IMPLEMENT_DYNAMIC_CLASS(wxStyledTextEvent
, wxCommandEvent
)
125 //----------------------------------------------------------------------
126 // Constructor and Destructor
128 wxStyledTextCtrl::wxStyledTextCtrl(wxWindow
*parent
,
133 const wxString
& name
) :
134 wxControl(parent
, id
, pos
, size
,
135 style
| wxVSCROLL
| wxHSCROLL
| wxWANTS_CHARS
| wxCLIP_CHILDREN
,
136 wxDefaultValidator
, name
)
138 m_swx
= new ScintillaWX(this);
143 wxStyledTextCtrl::~wxStyledTextCtrl() {
148 //----------------------------------------------------------------------
150 long wxStyledTextCtrl::SendMsg(int msg
, long wp
, long lp
) {
152 return m_swx
->WndProc(msg
, wp
, lp
);
160 #define MAKELONG(a, b) ((a) | ((b) << 16))
163 static long wxColourAsLong(const wxColour
& co
) {
164 return (((long)co
.Blue() << 16) |
165 ((long)co
.Green() << 8) |
169 static wxColour
wxColourFromLong(long c
) {
171 clr
.Set(c
& 0xff, (c
>> 8) & 0xff, (c
>> 16) & 0xff);
176 static wxColour
wxColourFromSpec(const wxString
& spec
) {
177 // spec should be #RRGGBB
179 int red
= strtol(spec
.Mid(1,2), &junk
, 16);
180 int green
= strtol(spec
.Mid(3,2), &junk
, 16);
181 int blue
= strtol(spec
.Mid(5,2), &junk
, 16);
182 return wxColour(red
, green
, blue
);
186 //----------------------------------------------------------------------
187 // BEGIN generated section. The following code is automatically generated
188 // by gen_iface.py from the contents of Scintilla.iface. Do not edit
189 // this file. Edit stc.cpp.in or gen_iface.py instead and regenerate.
192 // Add text to the document
193 void wxStyledTextCtrl::AddText(const wxString
& text
) {
194 SendMsg(2001, text
.Len(), (long)text
.c_str());
197 // Add array of cells to document
198 void wxStyledTextCtrl::AddStyledText(const wxString
& text
) {
199 SendMsg(2002, text
.Len(), (long)text
.c_str());
202 // Insert string at a position
203 void wxStyledTextCtrl::InsertText(int pos
, const wxString
& text
) {
204 SendMsg(2003, pos
, (long)text
.c_str());
207 // Delete all text in the document
208 void wxStyledTextCtrl::ClearAll() {
212 // Set all style bytes to 0, remove all folding information
213 void wxStyledTextCtrl::ClearDocumentStyle() {
217 // The number of characters in the document
218 int wxStyledTextCtrl::GetLength() {
219 return SendMsg(2006, 0, 0);
222 // Returns the character byte at the position
223 int wxStyledTextCtrl::GetCharAt(int pos
) {
224 return SendMsg(2007, pos
, 0);
227 // Returns the position of the caret
228 int wxStyledTextCtrl::GetCurrentPos() {
229 return SendMsg(2008, 0, 0);
232 // Returns the position of the opposite end of the selection to the caret
233 int wxStyledTextCtrl::GetAnchor() {
234 return SendMsg(2009, 0, 0);
237 // Returns the style byte at the position
238 int wxStyledTextCtrl::GetStyleAt(int pos
) {
239 return SendMsg(2010, pos
, 0);
242 // Redoes the next action on the undo history
243 void wxStyledTextCtrl::Redo() {
247 // Choose between collecting actions into the undo
248 // history and discarding them.
249 void wxStyledTextCtrl::SetUndoCollection(bool collectUndo
) {
250 SendMsg(2012, collectUndo
, 0);
253 // Select all the text in the document.
254 void wxStyledTextCtrl::SelectAll() {
258 // Remember the current position in the undo history as the position
259 // at which the document was saved.
260 void wxStyledTextCtrl::SetSavePoint() {
264 // Retrieve a buffer of cells.
265 wxString
wxStyledTextCtrl::GetStyledText(int startPos
, int endPos
) {
267 int len
= endPos
- startPos
;
270 tr
.lpstrText
= text
.GetWriteBuf(len
*2);
271 tr
.chrg
.cpMin
= startPos
;
272 tr
.chrg
.cpMax
= endPos
;
273 SendMsg(2015, 0, (long)&tr
);
274 text
.UngetWriteBuf(len
*2);
278 // Are there any redoable actions in the undo history.
279 bool wxStyledTextCtrl::CanRedo() {
280 return SendMsg(2016, 0, 0) != 0;
283 // Retrieve the line number at which a particular marker is located
284 int wxStyledTextCtrl::MarkerLineFromHandle(int handle
) {
285 return SendMsg(2017, handle
, 0);
289 void wxStyledTextCtrl::MarkerDeleteHandle(int handle
) {
290 SendMsg(2018, handle
, 0);
293 // Is undo history being collected?
294 bool wxStyledTextCtrl::GetUndoCollection() {
295 return SendMsg(2019, 0, 0) != 0;
298 // Are white space characters currently visible?
299 // Returns one of SCWS_* constants.
300 int wxStyledTextCtrl::GetViewWhiteSpace() {
301 return SendMsg(2020, 0, 0);
304 // Make white space characters invisible, always visible or visible outside indentation.
305 void wxStyledTextCtrl::SetViewWhiteSpace(int viewWS
) {
306 SendMsg(2021, viewWS
, 0);
309 // Find the position from a point within the window.
310 int wxStyledTextCtrl::PositionFromPoint(wxPoint pt
) {
311 return SendMsg(2022, pt
.x
, pt
.y
);
314 // Find the position from a point within the window but return
315 // INVALID_POSITION if not close to text.
316 int wxStyledTextCtrl::PositionFromPointClose(int x
, int y
) {
317 return SendMsg(2023, x
, y
);
320 // Set caret to start of a line and ensure it is visible.
321 void wxStyledTextCtrl::GotoLine(int line
) {
322 SendMsg(2024, line
, 0);
325 // Set caret to a position and ensure it is visible.
326 void wxStyledTextCtrl::GotoPos(int pos
) {
327 SendMsg(2025, pos
, 0);
330 // Set the selection anchor to a position. The anchor is the opposite
331 // end of the selection from the caret.
332 void wxStyledTextCtrl::SetAnchor(int posAnchor
) {
333 SendMsg(2026, posAnchor
, 0);
336 // Retrieve the text of the line containing the caret.
337 // Returns the index of the caret on the line.
338 wxString
wxStyledTextCtrl::GetCurLine(int* linePos
) {
340 int len
= LineLength(GetCurrentLine());
342 if (linePos
) *linePos
= 0;
345 // Need an extra byte because SCI_GETCURLINE writes a null to the string
346 char* buf
= text
.GetWriteBuf(len
+1);
348 int pos
= SendMsg(2027, len
+1, (long)buf
);
349 text
.UngetWriteBuf(len
);
350 if (linePos
) *linePos
= pos
;
355 // Retrieve the position of the last correctly styled character.
356 int wxStyledTextCtrl::GetEndStyled() {
357 return SendMsg(2028, 0, 0);
360 // Convert all line endings in the document to one mode.
361 void wxStyledTextCtrl::ConvertEOLs(int eolMode
) {
362 SendMsg(2029, eolMode
, 0);
365 // Retrieve the current end of line mode - one of CRLF, CR, or LF.
366 int wxStyledTextCtrl::GetEOLMode() {
367 return SendMsg(2030, 0, 0);
370 // Set the current end of line mode.
371 void wxStyledTextCtrl::SetEOLMode(int eolMode
) {
372 SendMsg(2031, eolMode
, 0);
375 // Set the current styling position to pos and the styling mask to mask.
376 // The styling mask can be used to protect some bits in each styling byte from
378 void wxStyledTextCtrl::StartStyling(int pos
, int mask
) {
379 SendMsg(2032, pos
, mask
);
382 // Change style from current styling position for length characters to a style
383 // and move the current styling position to after this newly styled segment.
384 void wxStyledTextCtrl::SetStyling(int length
, int style
) {
385 SendMsg(2033, length
, style
);
388 // Is drawing done first into a buffer or direct to the screen.
389 bool wxStyledTextCtrl::GetBufferedDraw() {
390 return SendMsg(2034, 0, 0) != 0;
393 // If drawing is buffered then each line of text is drawn into a bitmap buffer
394 // before drawing it to the screen to avoid flicker.
395 void wxStyledTextCtrl::SetBufferedDraw(bool buffered
) {
396 SendMsg(2035, buffered
, 0);
399 // Change the visible size of a tab to be a multiple of the width of a space
401 void wxStyledTextCtrl::SetTabWidth(int tabWidth
) {
402 SendMsg(2036, tabWidth
, 0);
405 // Retrieve the visible size of a tab.
406 int wxStyledTextCtrl::GetTabWidth() {
407 return SendMsg(2121, 0, 0);
410 // Set the code page used to interpret the bytes of the document as characters.
411 // The SC_CP_UTF8 value can be used to enter Unicode mode.
412 void wxStyledTextCtrl::SetCodePage(int codePage
) {
413 SendMsg(2037, codePage
, 0);
416 // Set the symbol used for a particular marker number,
417 // and optionally the for and background colours.
418 void wxStyledTextCtrl::MarkerDefine(int markerNumber
, int markerSymbol
,
419 const wxColour
& foreground
,
420 const wxColour
& background
) {
422 SendMsg(2040, markerNumber
, markerSymbol
);
424 MarkerSetForeground(markerNumber
, foreground
);
426 MarkerSetBackground(markerNumber
, background
);
429 // Set the foreground colour used for a particular marker number.
430 void wxStyledTextCtrl::MarkerSetForeground(int markerNumber
, const wxColour
& fore
) {
431 SendMsg(2041, markerNumber
, wxColourAsLong(fore
));
434 // Set the background colour used for a particular marker number.
435 void wxStyledTextCtrl::MarkerSetBackground(int markerNumber
, const wxColour
& back
) {
436 SendMsg(2042, markerNumber
, wxColourAsLong(back
));
439 // Add a marker to a line.
440 void wxStyledTextCtrl::MarkerAdd(int line
, int markerNumber
) {
441 SendMsg(2043, line
, markerNumber
);
444 // Delete a marker from a line
445 void wxStyledTextCtrl::MarkerDelete(int line
, int markerNumber
) {
446 SendMsg(2044, line
, markerNumber
);
449 // Delete all markers with a particular number from all lines
450 void wxStyledTextCtrl::MarkerDeleteAll(int markerNumber
) {
451 SendMsg(2045, markerNumber
, 0);
454 // Get a bit mask of all the markers set on a line.
455 int wxStyledTextCtrl::MarkerGet(int line
) {
456 return SendMsg(2046, line
, 0);
459 // Find the next line after lineStart that includes a marker in mask.
460 int wxStyledTextCtrl::MarkerNext(int lineStart
, int markerMask
) {
461 return SendMsg(2047, lineStart
, markerMask
);
464 // Find the previous line before lineStart that includes a marker in mask.
465 int wxStyledTextCtrl::MarkerPrevious(int lineStart
, int markerMask
) {
466 return SendMsg(2048, lineStart
, markerMask
);
469 // Set a margin to be either numeric or symbolic.
470 void wxStyledTextCtrl::SetMarginType(int margin
, int marginType
) {
471 SendMsg(2240, margin
, marginType
);
474 // Retrieve the type of a margin.
475 int wxStyledTextCtrl::GetMarginType(int margin
) {
476 return SendMsg(2241, margin
, 0);
479 // Set the width of a margin to a width expressed in pixels.
480 void wxStyledTextCtrl::SetMarginWidth(int margin
, int pixelWidth
) {
481 SendMsg(2242, margin
, pixelWidth
);
484 // Retrieve the width of a margin in pixels.
485 int wxStyledTextCtrl::GetMarginWidth(int margin
) {
486 return SendMsg(2243, margin
, 0);
489 // Set a mask that determines which markers are displayed in a margin.
490 void wxStyledTextCtrl::SetMarginMask(int margin
, int mask
) {
491 SendMsg(2244, margin
, mask
);
494 // Retrieve the marker mask of a margin.
495 int wxStyledTextCtrl::GetMarginMask(int margin
) {
496 return SendMsg(2245, margin
, 0);
499 // Make a margin sensitive or insensitive to mouse clicks.
500 void wxStyledTextCtrl::SetMarginSensitive(int margin
, bool sensitive
) {
501 SendMsg(2246, margin
, sensitive
);
504 // Retrieve the mouse click sensitivity of a margin.
505 bool wxStyledTextCtrl::GetMarginSensitive(int margin
) {
506 return SendMsg(2247, margin
, 0) != 0;
509 // Clear all the styles and make equivalent to the global default style.
510 void wxStyledTextCtrl::StyleClearAll() {
514 // Set the foreground colour of a style.
515 void wxStyledTextCtrl::StyleSetForeground(int style
, const wxColour
& fore
) {
516 SendMsg(2051, style
, wxColourAsLong(fore
));
519 // Set the background colour of a style.
520 void wxStyledTextCtrl::StyleSetBackground(int style
, const wxColour
& back
) {
521 SendMsg(2052, style
, wxColourAsLong(back
));
524 // Set a style to be bold or not.
525 void wxStyledTextCtrl::StyleSetBold(int style
, bool bold
) {
526 SendMsg(2053, style
, bold
);
529 // Set a style to be italic or not.
530 void wxStyledTextCtrl::StyleSetItalic(int style
, bool italic
) {
531 SendMsg(2054, style
, italic
);
534 // Set the size of characters of a style.
535 void wxStyledTextCtrl::StyleSetSize(int style
, int sizePoints
) {
536 SendMsg(2055, style
, sizePoints
);
539 // Set the font of a style.
540 void wxStyledTextCtrl::StyleSetFaceName(int style
, const wxString
& fontName
) {
541 SendMsg(2056, style
, (long)fontName
.c_str());
544 // Set a style to have its end of line filled or not.
545 void wxStyledTextCtrl::StyleSetEOLFilled(int style
, bool filled
) {
546 SendMsg(2057, style
, filled
);
549 // Reset the default style to its state at startup
550 void wxStyledTextCtrl::StyleResetDefault() {
554 // Set a style to be underlined or not.
555 void wxStyledTextCtrl::StyleSetUnderline(int style
, bool underline
) {
556 SendMsg(2059, style
, underline
);
559 // Set a style to be mixed case, or to force upper or lower case.
560 void wxStyledTextCtrl::StyleSetCase(int style
, int caseForce
) {
561 SendMsg(2060, style
, caseForce
);
564 // Set the foreground colour of the selection and whether to use this setting.
565 void wxStyledTextCtrl::SetSelForeground(bool useSetting
, const wxColour
& fore
) {
566 SendMsg(2067, useSetting
, wxColourAsLong(fore
));
569 // Set the background colour of the selection and whether to use this setting.
570 void wxStyledTextCtrl::SetSelBackground(bool useSetting
, const wxColour
& back
) {
571 SendMsg(2068, useSetting
, wxColourAsLong(back
));
574 // Set the foreground colour of the caret.
575 void wxStyledTextCtrl::SetCaretForeground(const wxColour
& fore
) {
576 SendMsg(2069, wxColourAsLong(fore
), 0);
579 // When key+modifier combination km is pressed perform msg.
580 void wxStyledTextCtrl::CmdKeyAssign(int key
, int modifiers
, int cmd
) {
581 SendMsg(2070, MAKELONG(key
, modifiers
), cmd
);
584 // When key+modifier combination km do nothing.
585 void wxStyledTextCtrl::CmdKeyClear(int key
, int modifiers
) {
586 SendMsg(2071, MAKELONG(key
, modifiers
));
589 // Drop all key mappings.
590 void wxStyledTextCtrl::CmdKeyClearAll() {
594 // Set the styles for a segment of the document.
595 void wxStyledTextCtrl::SetStyleBytes(int length
, char* styleBytes
) {
596 SendMsg(2073, length
, (long)styleBytes
);
599 // Set a style to be visible or not.
600 void wxStyledTextCtrl::StyleSetVisible(int style
, bool visible
) {
601 SendMsg(2074, style
, visible
);
604 // Get the time in milliseconds that the caret is on and off.
605 int wxStyledTextCtrl::GetCaretPeriod() {
606 return SendMsg(2075, 0, 0);
609 // Get the time in milliseconds that the caret is on and off. 0 = steady on.
610 void wxStyledTextCtrl::SetCaretPeriod(int periodMilliseconds
) {
611 SendMsg(2076, periodMilliseconds
, 0);
614 // Set the set of characters making up words for when moving or selecting
616 void wxStyledTextCtrl::SetWordChars(const wxString
& characters
) {
617 SendMsg(2077, 0, (long)characters
.c_str());
620 // Start a sequence of actions that is undone and redone as a unit.
622 void wxStyledTextCtrl::BeginUndoAction() {
626 // End a sequence of actions that is undone and redone as a unit.
627 void wxStyledTextCtrl::EndUndoAction() {
631 // Set an indicator to plain, squiggle or TT.
632 void wxStyledTextCtrl::IndicatorSetStyle(int indic
, int style
) {
633 SendMsg(2080, indic
, style
);
636 // Retrieve the style of an indicator.
637 int wxStyledTextCtrl::IndicatorGetStyle(int indic
) {
638 return SendMsg(2081, indic
, 0);
641 // Set the foreground colour of an indicator.
642 void wxStyledTextCtrl::IndicatorSetForeground(int indic
, const wxColour
& fore
) {
643 SendMsg(2082, indic
, wxColourAsLong(fore
));
646 // Retrieve the foreground colour of an indicator.
647 wxColour
wxStyledTextCtrl::IndicatorGetForeground(int indic
) {
648 long c
= SendMsg(2083, indic
, 0);
649 return wxColourFromLong(c
);
652 // Divide each styling byte into lexical class bits (default:5) and indicator
653 // bits (default:3). If a lexer requires more than 32 lexical states, then this
654 // is used to expand the possible states.
655 void wxStyledTextCtrl::SetStyleBits(int bits
) {
656 SendMsg(2090, bits
, 0);
659 // Retrieve number of bits in style bytes used to hold the lexical state.
660 int wxStyledTextCtrl::GetStyleBits() {
661 return SendMsg(2091, 0, 0);
664 // Used to hold extra styling information for each line.
665 void wxStyledTextCtrl::SetLineState(int line
, int state
) {
666 SendMsg(2092, line
, state
);
669 // Retrieve the extra styling information for a line.
670 int wxStyledTextCtrl::GetLineState(int line
) {
671 return SendMsg(2093, line
, 0);
674 // Retrieve the last line number that has line state.
675 int wxStyledTextCtrl::GetMaxLineState() {
676 return SendMsg(2094, 0, 0);
679 // Is the background of the line containing the caret in a different colour?
680 bool wxStyledTextCtrl::GetCaretLineVisible() {
681 return SendMsg(2095, 0, 0) != 0;
684 // Display the background of the line containing the caret in a different colour.
685 void wxStyledTextCtrl::SetCaretLineVisible(bool show
) {
686 SendMsg(2096, show
, 0);
689 // Get the colour of the background of the line containing the caret.
690 wxColour
wxStyledTextCtrl::GetCaretLineBack() {
691 long c
= SendMsg(2097, 0, 0);
692 return wxColourFromLong(c
);
695 // Set the colour of the background of the line containing the caret.
696 void wxStyledTextCtrl::SetCaretLineBack(const wxColour
& back
) {
697 SendMsg(2098, wxColourAsLong(back
), 0);
700 // Display a auto-completion list.
701 // The lenEntered parameter indicates how many characters before
702 // the caret should be used to provide context.
703 void wxStyledTextCtrl::AutoCompShow(int lenEntered
, const wxString
& itemList
) {
704 SendMsg(2100, lenEntered
, (long)itemList
.c_str());
707 // Remove the auto-completion list from the screen.
708 void wxStyledTextCtrl::AutoCompCancel() {
712 // Is there an auto-completion list visible?
713 bool wxStyledTextCtrl::AutoCompActive() {
714 return SendMsg(2102, 0, 0) != 0;
717 // Retrieve the position of the caret when the auto-completion list was
719 int wxStyledTextCtrl::AutoCompPosStart() {
720 return SendMsg(2103, 0, 0);
723 // User has selected an item so remove the list and insert the selection.
724 void wxStyledTextCtrl::AutoCompComplete() {
728 // Define a set of character that when typed cancel the auto-completion list.
729 void wxStyledTextCtrl::AutoCompStops(const wxString
& characterSet
) {
730 SendMsg(2105, 0, (long)characterSet
.c_str());
733 // Change the separator character in the string setting up an auto-completion
734 // list. Default is space but can be changed if items contain space.
735 void wxStyledTextCtrl::AutoCompSetSeparator(int separatorCharacter
) {
736 SendMsg(2106, separatorCharacter
, 0);
739 // Retrieve the auto-completion list separator character.
740 int wxStyledTextCtrl::AutoCompGetSeparator() {
741 return SendMsg(2107, 0, 0);
744 // Select the item in the auto-completion list that starts with a string.
745 void wxStyledTextCtrl::AutoCompSelect(const wxString
& text
) {
746 SendMsg(2108, 0, (long)text
.c_str());
749 // Should the auto-completion list be cancelled if the user backspaces to a
750 // position before where the box was created.
751 void wxStyledTextCtrl::AutoCompSetCancelAtStart(bool cancel
) {
752 SendMsg(2110, cancel
, 0);
755 // Retrieve whether auto-completion cancelled by backspacing before start.
756 bool wxStyledTextCtrl::AutoCompGetCancelAtStart() {
757 return SendMsg(2111, 0, 0) != 0;
760 // Define a set of character that when typed fills up the selected word.
761 void wxStyledTextCtrl::AutoCompSetFillUps(const wxString
& characterSet
) {
762 SendMsg(2112, 0, (long)characterSet
.c_str());
765 // Should a single item auto-completion list automatically choose the item.
766 void wxStyledTextCtrl::AutoCompSetChooseSingle(bool chooseSingle
) {
767 SendMsg(2113, chooseSingle
, 0);
770 // Retrieve whether a single item auto-completion list automatically choose the item.
771 bool wxStyledTextCtrl::AutoCompGetChooseSingle() {
772 return SendMsg(2114, 0, 0) != 0;
775 // Set whether case is significant when performing auto-completion searches.
776 void wxStyledTextCtrl::AutoCompSetIgnoreCase(bool ignoreCase
) {
777 SendMsg(2115, ignoreCase
, 0);
780 // Retrieve state of ignore case flag.
781 bool wxStyledTextCtrl::AutoCompGetIgnoreCase() {
782 return SendMsg(2116, 0, 0) != 0;
785 // Display a list of strings and send notification when user chooses one.
786 void wxStyledTextCtrl::UserListShow(int listType
, const wxString
& itemList
) {
787 SendMsg(2117, listType
, (long)itemList
.c_str());
790 // Set whether or not autocompletion is hidden automatically when nothing matches
791 void wxStyledTextCtrl::AutoCompSetAutoHide(bool autoHide
) {
792 SendMsg(2118, autoHide
, 0);
795 // Retrieve whether or not autocompletion is hidden automatically when nothing matches
796 bool wxStyledTextCtrl::AutoCompGetAutoHide() {
797 return SendMsg(2119, 0, 0) != 0;
800 // Set the number of spaces used for one level of indentation.
801 void wxStyledTextCtrl::SetIndent(int indentSize
) {
802 SendMsg(2122, indentSize
, 0);
805 // Retrieve indentation size.
806 int wxStyledTextCtrl::GetIndent() {
807 return SendMsg(2123, 0, 0);
810 // Indentation will only use space characters if useTabs is false, otherwise
811 // it will use a combination of tabs and spaces.
812 void wxStyledTextCtrl::SetUseTabs(bool useTabs
) {
813 SendMsg(2124, useTabs
, 0);
816 // Retrieve whether tabs will be used in indentation.
817 bool wxStyledTextCtrl::GetUseTabs() {
818 return SendMsg(2125, 0, 0) != 0;
821 // Change the indentation of a line to a number of columns.
822 void wxStyledTextCtrl::SetLineIndentation(int line
, int indentSize
) {
823 SendMsg(2126, line
, indentSize
);
826 // Retrieve the number of columns that a line is indented.
827 int wxStyledTextCtrl::GetLineIndentation(int line
) {
828 return SendMsg(2127, line
, 0);
831 // Retrieve the position before the first non indentation character on a line.
832 int wxStyledTextCtrl::GetLineIndentPosition(int line
) {
833 return SendMsg(2128, line
, 0);
836 // Retrieve the column number of a position, taking tab width into account.
837 int wxStyledTextCtrl::GetColumn(int pos
) {
838 return SendMsg(2129, pos
, 0);
841 // Show or hide the horizontal scroll bar.
842 void wxStyledTextCtrl::SetUseHorizontalScrollBar(bool show
) {
843 SendMsg(2130, show
, 0);
846 // Is the horizontal scroll bar visible?
847 bool wxStyledTextCtrl::GetUseHorizontalScrollBar() {
848 return SendMsg(2131, 0, 0) != 0;
851 // Show or hide indentation guides.
852 void wxStyledTextCtrl::SetIndentationGuides(bool show
) {
853 SendMsg(2132, show
, 0);
856 // Are the indentation guides visible?
857 bool wxStyledTextCtrl::GetIndentationGuides() {
858 return SendMsg(2133, 0, 0) != 0;
861 // Set the highlighted indentation guide column.
862 // 0 = no highlighted guide.
863 void wxStyledTextCtrl::SetHighlightGuide(int column
) {
864 SendMsg(2134, column
, 0);
867 // Get the highlighted indentation guide column.
868 int wxStyledTextCtrl::GetHighlightGuide() {
869 return SendMsg(2135, 0, 0);
872 // Get the position after the last visible characters on a line.
873 int wxStyledTextCtrl::GetLineEndPosition(int line
) {
874 return SendMsg(2136, line
, 0);
877 // Get the code page used to interpret the bytes of the document as characters.
878 int wxStyledTextCtrl::GetCodePage() {
879 return SendMsg(2137, 0, 0);
882 // Get the foreground colour of the caret.
883 wxColour
wxStyledTextCtrl::GetCaretForeground() {
884 long c
= SendMsg(2138, 0, 0);
885 return wxColourFromLong(c
);
888 // In read-only mode?
889 bool wxStyledTextCtrl::GetReadOnly() {
890 return SendMsg(2140, 0, 0) != 0;
893 // Sets the position of the caret.
894 void wxStyledTextCtrl::SetCurrentPos(int pos
) {
895 SendMsg(2141, pos
, 0);
898 // Sets the position that starts the selection - this becomes the anchor.
899 void wxStyledTextCtrl::SetSelectionStart(int pos
) {
900 SendMsg(2142, pos
, 0);
903 // Returns the position at the start of the selection.
904 int wxStyledTextCtrl::GetSelectionStart() {
905 return SendMsg(2143, 0, 0);
908 // Sets the position that ends the selection - this becomes the currentPosition.
909 void wxStyledTextCtrl::SetSelectionEnd(int pos
) {
910 SendMsg(2144, pos
, 0);
913 // Returns the position at the end of the selection.
914 int wxStyledTextCtrl::GetSelectionEnd() {
915 return SendMsg(2145, 0, 0);
918 // Sets the print magnification added to the point size of each style for printing.
919 void wxStyledTextCtrl::SetPrintMagnification(int magnification
) {
920 SendMsg(2146, magnification
, 0);
923 // Returns the print magnification.
924 int wxStyledTextCtrl::GetPrintMagnification() {
925 return SendMsg(2147, 0, 0);
928 // Modify colours when printing for clearer printed text.
929 void wxStyledTextCtrl::SetPrintColourMode(int mode
) {
930 SendMsg(2148, mode
, 0);
933 // Returns the print colour mode.
934 int wxStyledTextCtrl::GetPrintColourMode() {
935 return SendMsg(2149, 0, 0);
938 // Find some text in the document.
939 int wxStyledTextCtrl::FindText(int minPos
, int maxPos
,
940 const wxString
& text
,
941 bool caseSensitive
, bool wholeWord
) {
945 flags
|= caseSensitive
? SCFIND_MATCHCASE
: 0;
946 flags
|= wholeWord
? SCFIND_WHOLEWORD
: 0;
947 ft
.chrg
.cpMin
= minPos
;
948 ft
.chrg
.cpMax
= maxPos
;
949 ft
.lpstrText
= (char*)text
.c_str();
951 return SendMsg(2150, flags
, (long)&ft
);
954 // On Windows will draw the document into a display context such as a printer.
955 int wxStyledTextCtrl::FormatRange(bool doDraw
,
959 wxDC
* target
, // Why does it use two? Can they be the same?
965 fr
.hdcTarget
= target
;
966 fr
.rc
.top
= renderRect
.GetTop();
967 fr
.rc
.left
= renderRect
.GetLeft();
968 fr
.rc
.right
= renderRect
.GetRight();
969 fr
.rc
.bottom
= renderRect
.GetBottom();
970 fr
.rcPage
.top
= pageRect
.GetTop();
971 fr
.rcPage
.left
= pageRect
.GetLeft();
972 fr
.rcPage
.right
= pageRect
.GetRight();
973 fr
.rcPage
.bottom
= pageRect
.GetBottom();
974 fr
.chrg
.cpMin
= startPos
;
975 fr
.chrg
.cpMax
= endPos
;
977 return SendMsg(2151, doDraw
, (long)&fr
);
980 // Retrieve the line at the top of the display.
981 int wxStyledTextCtrl::GetFirstVisibleLine() {
982 return SendMsg(2152, 0, 0);
985 // Retrieve the contents of a line.
986 wxString
wxStyledTextCtrl::GetLine(int line
) {
988 int len
= LineLength(line
);
990 char* buf
= text
.GetWriteBuf(len
);
992 int pos
= SendMsg(2153, line
, (long)buf
);
993 text
.UngetWriteBuf(len
);
998 // Returns the number of lines in the document. There is always at least one.
999 int wxStyledTextCtrl::GetLineCount() {
1000 return SendMsg(2154, 0, 0);
1003 // Sets the size in pixels of the left margin.
1004 void wxStyledTextCtrl::SetMarginLeft(int pixelWidth
) {
1005 SendMsg(2155, 0, pixelWidth
);
1008 // Returns the size in pixels of the left margin.
1009 int wxStyledTextCtrl::GetMarginLeft() {
1010 return SendMsg(2156, 0, 0);
1013 // Sets the size in pixels of the right margin.
1014 void wxStyledTextCtrl::SetMarginRight(int pixelWidth
) {
1015 SendMsg(2157, 0, pixelWidth
);
1018 // Returns the size in pixels of the right margin.
1019 int wxStyledTextCtrl::GetMarginRight() {
1020 return SendMsg(2158, 0, 0);
1023 // Is the document different from when it was last saved?
1024 bool wxStyledTextCtrl::GetModify() {
1025 return SendMsg(2159, 0, 0) != 0;
1028 // Select a range of text.
1029 void wxStyledTextCtrl::SetSelection(int start
, int end
) {
1030 SendMsg(2160, start
, end
);
1033 // Retrieve the selected text.
1034 wxString
wxStyledTextCtrl::GetSelectedText() {
1039 GetSelection(&start
, &end
);
1040 int len
= end
- start
;
1041 if (!len
) return "";
1042 char* buff
= text
.GetWriteBuf(len
);
1044 SendMsg(2161, 0, (long)buff
);
1045 text
.UngetWriteBuf(len
);
1049 // Retrieve a range of text.
1050 wxString
wxStyledTextCtrl::GetTextRange(int startPos
, int endPos
) {
1052 int len
= endPos
- startPos
;
1053 if (!len
) return "";
1054 char* buff
= text
.GetWriteBuf(len
);
1056 tr
.lpstrText
= buff
;
1057 tr
.chrg
.cpMin
= startPos
;
1058 tr
.chrg
.cpMax
= endPos
;
1060 SendMsg(2162, 0, (long)&tr
);
1061 text
.UngetWriteBuf(len
);
1065 // Draw the selection in normal style or with selection highlighted.
1066 void wxStyledTextCtrl::HideSelection(bool normal
) {
1067 SendMsg(2163, normal
, 0);
1070 // Retrieve the line containing a position.
1071 int wxStyledTextCtrl::LineFromPosition(int pos
) {
1072 return SendMsg(2166, pos
, 0);
1075 // Retrieve the position at the start of a line.
1076 int wxStyledTextCtrl::PositionFromLine(int line
) {
1077 return SendMsg(2167, line
, 0);
1080 // Scroll horizontally and vertically.
1081 void wxStyledTextCtrl::LineScroll(int columns
, int lines
) {
1082 SendMsg(2168, columns
, lines
);
1085 // Ensure the caret is visible.
1086 void wxStyledTextCtrl::EnsureCaretVisible() {
1087 SendMsg(2169, 0, 0);
1090 // Replace the selected text with the argument text.
1091 void wxStyledTextCtrl::ReplaceSelection(const wxString
& text
) {
1092 SendMsg(2170, 0, (long)text
.c_str());
1095 // Set to read only or read write.
1096 void wxStyledTextCtrl::SetReadOnly(bool readOnly
) {
1097 SendMsg(2171, readOnly
, 0);
1100 // Will a paste succeed?
1101 bool wxStyledTextCtrl::CanPaste() {
1102 return SendMsg(2173, 0, 0) != 0;
1105 // Are there any undoable actions in the undo history.
1106 bool wxStyledTextCtrl::CanUndo() {
1107 return SendMsg(2174, 0, 0) != 0;
1110 // Delete the undo history.
1111 void wxStyledTextCtrl::EmptyUndoBuffer() {
1112 SendMsg(2175, 0, 0);
1115 // Undo one action in the undo history.
1116 void wxStyledTextCtrl::Undo() {
1117 SendMsg(2176, 0, 0);
1120 // Cut the selection to the clipboard.
1121 void wxStyledTextCtrl::Cut() {
1122 SendMsg(2177, 0, 0);
1125 // Copy the selection to the clipboard.
1126 void wxStyledTextCtrl::Copy() {
1127 SendMsg(2178, 0, 0);
1130 // Paste the contents of the clipboard into the document replacing the selection.
1131 void wxStyledTextCtrl::Paste() {
1132 SendMsg(2179, 0, 0);
1135 // Clear the selection.
1136 void wxStyledTextCtrl::Clear() {
1137 SendMsg(2180, 0, 0);
1140 // Replace the contents of the document with the argument text.
1141 void wxStyledTextCtrl::SetText(const wxString
& text
) {
1142 SendMsg(2181, 0, (long)text
.c_str());
1145 // Retrieve all the text in the document.
1146 wxString
wxStyledTextCtrl::GetText() {
1148 int len
= GetTextLength();
1149 char* buff
= text
.GetWriteBuf(len
+1); // leave room for the null...
1151 SendMsg(2182, len
+1, (long)buff
);
1152 text
.UngetWriteBuf(len
);
1156 // Retrieve the number of characters in the document.
1157 int wxStyledTextCtrl::GetTextLength() {
1158 return SendMsg(2183, 0, 0);
1161 // Set to overtype (true) or insert mode
1162 void wxStyledTextCtrl::SetOvertype(bool overtype
) {
1163 SendMsg(2186, overtype
, 0);
1166 // Returns true if overtype mode is active otherwise false is returned.
1167 bool wxStyledTextCtrl::GetOvertype() {
1168 return SendMsg(2187, 0, 0) != 0;
1171 // Set the width of the insert mode caret
1172 void wxStyledTextCtrl::SetCaretWidth(int pixelWidth
) {
1173 SendMsg(2188, pixelWidth
, 0);
1176 // Returns the width of the insert mode caret
1177 int wxStyledTextCtrl::GetCaretWidth() {
1178 return SendMsg(2189, 0, 0);
1181 // Sets the position that starts the target which is used for updating the
1182 // document without affecting the scroll position.
1183 void wxStyledTextCtrl::SetTargetStart(int pos
) {
1184 SendMsg(2190, pos
, 0);
1187 // Get the position that starts the target.
1188 int wxStyledTextCtrl::GetTargetStart() {
1189 return SendMsg(2191, 0, 0);
1192 // Sets the position that ends the target which is used for updating the
1193 // document without affecting the scroll position.
1194 void wxStyledTextCtrl::SetTargetEnd(int pos
) {
1195 SendMsg(2192, pos
, 0);
1198 // Get the position that ends the target.
1199 int wxStyledTextCtrl::GetTargetEnd() {
1200 return SendMsg(2193, 0, 0);
1203 // Replace the target text with the argument text.
1204 // Returns the length of the replacement text.
1206 int wxStyledTextCtrl::ReplaceTarget(const wxString
& text
) {
1207 return SendMsg(2194, text
.Len(), (long)text
.c_str());
1211 // Replace the target text with the argument text after \d processing.
1212 // Looks for \d where d is between 1 and 9 and replaces these with the strings
1213 // matched in the last search operation which were surrounded by \( and \).
1214 // Returns the length of the replacement text including any change
1215 // caused by processing the \d patterns.
1217 int wxStyledTextCtrl::ReplaceTargetRE(const wxString
& text
) {
1218 return SendMsg(2195, text
.Len(), (long)text
.c_str());
1222 // Search for a counted string in the target and set the target to the found
1224 // Returns length of range or -1 for failure in which case target is not moved.
1226 int wxStyledTextCtrl::SearchInTarget(const wxString
& text
) {
1227 return SendMsg(2197, text
.Len(), (long)text
.c_str());
1231 // Set the search flags used by SearchInTarget
1232 void wxStyledTextCtrl::SetSearchFlags(int flags
) {
1233 SendMsg(2198, flags
, 0);
1236 // Get the search flags used by SearchInTarget
1237 int wxStyledTextCtrl::GetSearchFlags() {
1238 return SendMsg(2199, 0, 0);
1241 // Show a call tip containing a definition near position pos.
1242 void wxStyledTextCtrl::CallTipShow(int pos
, const wxString
& definition
) {
1243 SendMsg(2200, pos
, (long)definition
.c_str());
1246 // Remove the call tip from the screen.
1247 void wxStyledTextCtrl::CallTipCancel() {
1248 SendMsg(2201, 0, 0);
1251 // Is there an active call tip?
1252 bool wxStyledTextCtrl::CallTipActive() {
1253 return SendMsg(2202, 0, 0) != 0;
1256 // Retrieve the position where the caret was before displaying the call tip.
1257 int wxStyledTextCtrl::CallTipPosAtStart() {
1258 return SendMsg(2203, 0, 0);
1261 // Highlight a segment of the definition.
1262 void wxStyledTextCtrl::CallTipSetHighlight(int start
, int end
) {
1263 SendMsg(2204, start
, end
);
1266 // Set the background colour for the call tip.
1267 void wxStyledTextCtrl::CallTipSetBackground(const wxColour
& back
) {
1268 SendMsg(2205, wxColourAsLong(back
), 0);
1271 // Find the display line of a document line taking hidden lines into account.
1272 int wxStyledTextCtrl::VisibleFromDocLine(int line
) {
1273 return SendMsg(2220, line
, 0);
1276 // Find the document line of a display line taking hidden lines into account.
1277 int wxStyledTextCtrl::DocLineFromVisible(int lineDisplay
) {
1278 return SendMsg(2221, lineDisplay
, 0);
1281 // Set the fold level of a line.
1282 // This encodes an integer level along with flags indicating whether the
1283 // line is a header and whether it is effectively white space.
1284 void wxStyledTextCtrl::SetFoldLevel(int line
, int level
) {
1285 SendMsg(2222, line
, level
);
1288 // Retrieve the fold level of a line.
1289 int wxStyledTextCtrl::GetFoldLevel(int line
) {
1290 return SendMsg(2223, line
, 0);
1293 // Find the last child line of a header line.
1294 int wxStyledTextCtrl::GetLastChild(int line
, int level
) {
1295 return SendMsg(2224, line
, level
);
1298 // Find the parent line of a child line.
1299 int wxStyledTextCtrl::GetFoldParent(int line
) {
1300 return SendMsg(2225, line
, 0);
1303 // Make a range of lines visible.
1304 void wxStyledTextCtrl::ShowLines(int lineStart
, int lineEnd
) {
1305 SendMsg(2226, lineStart
, lineEnd
);
1308 // Make a range of lines invisible.
1309 void wxStyledTextCtrl::HideLines(int lineStart
, int lineEnd
) {
1310 SendMsg(2227, lineStart
, lineEnd
);
1313 // Is a line visible?
1314 bool wxStyledTextCtrl::GetLineVisible(int line
) {
1315 return SendMsg(2228, line
, 0) != 0;
1318 // Show the children of a header line.
1319 void wxStyledTextCtrl::SetFoldExpanded(int line
, bool expanded
) {
1320 SendMsg(2229, line
, expanded
);
1323 // Is a header line expanded?
1324 bool wxStyledTextCtrl::GetFoldExpanded(int line
) {
1325 return SendMsg(2230, line
, 0) != 0;
1328 // Switch a header line between expanded and contracted.
1329 void wxStyledTextCtrl::ToggleFold(int line
) {
1330 SendMsg(2231, line
, 0);
1333 // Ensure a particular line is visible by expanding any header line hiding it.
1334 void wxStyledTextCtrl::EnsureVisible(int line
) {
1335 SendMsg(2232, line
, 0);
1338 // Set some debugging options for folding
1339 void wxStyledTextCtrl::SetFoldFlags(int flags
) {
1340 SendMsg(2233, flags
, 0);
1343 // Ensure a particular line is visible by expanding any header line hiding it.
1344 // Use the currently set visibility policy to determine which range to display.
1345 void wxStyledTextCtrl::EnsureVisibleEnforcePolicy(int line
) {
1346 SendMsg(2234, line
, 0);
1349 // Sets whether a tab pressed when caret is within indentation indents
1350 void wxStyledTextCtrl::SetTabIndents(bool tabIndents
) {
1351 SendMsg(2260, tabIndents
, 0);
1354 // Does a tab pressed when caret is within indentation indent?
1355 bool wxStyledTextCtrl::GetTabIndents() {
1356 return SendMsg(2261, 0, 0) != 0;
1359 // Sets whether a backspace pressed when caret is within indentation unindents
1360 void wxStyledTextCtrl::SetBackSpaceUnIndents(bool bsUnIndents
) {
1361 SendMsg(2262, bsUnIndents
, 0);
1364 // Does a backspace pressed when caret is within indentation unindent?
1365 bool wxStyledTextCtrl::GetBackSpaceUnIndents() {
1366 return SendMsg(2263, 0, 0) != 0;
1369 // Sets the time the mouse must sit still to generate a mouse dwell event
1370 void wxStyledTextCtrl::SetMouseDwellTime(int periodMilliseconds
) {
1371 SendMsg(2264, periodMilliseconds
, 0);
1374 // Retrieve the time the mouse must sit still to generate a mouse dwell event
1375 int wxStyledTextCtrl::GetMouseDwellTime() {
1376 return SendMsg(2265, 0, 0);
1379 // Move the caret inside current view if it's not there already
1380 void wxStyledTextCtrl::MoveCaretInsideView() {
1381 SendMsg(2401, 0, 0);
1384 // How many characters are on a line, not including end of line characters.
1385 int wxStyledTextCtrl::LineLength(int line
) {
1386 return SendMsg(2350, line
, 0);
1389 // Highlight the characters at two positions.
1390 void wxStyledTextCtrl::BraceHighlight(int pos1
, int pos2
) {
1391 SendMsg(2351, pos1
, pos2
);
1394 // Highlight the character at a position indicating there is no matching brace.
1395 void wxStyledTextCtrl::BraceBadLight(int pos
) {
1396 SendMsg(2352, pos
, 0);
1399 // Find the position of a matching brace or INVALID_POSITION if no match.
1400 int wxStyledTextCtrl::BraceMatch(int pos
) {
1401 return SendMsg(2353, pos
, 0);
1404 // Are the end of line characters visible.
1405 bool wxStyledTextCtrl::GetViewEOL() {
1406 return SendMsg(2355, 0, 0) != 0;
1409 // Make the end of line characters visible or invisible
1410 void wxStyledTextCtrl::SetViewEOL(bool visible
) {
1411 SendMsg(2356, visible
, 0);
1414 // Retrieve a pointer to the document object.
1415 void* wxStyledTextCtrl::GetDocPointer() {
1416 return (void*)SendMsg(2357);
1419 // Change the document object used.
1420 void wxStyledTextCtrl::SetDocPointer(void* docPointer
) {
1421 SendMsg(2358, 0, (long)docPointer
);
1424 // Set which document modification events are sent to the container.
1425 void wxStyledTextCtrl::SetModEventMask(int mask
) {
1426 SendMsg(2359, mask
, 0);
1429 // Retrieve the column number which text should be kept within.
1430 int wxStyledTextCtrl::GetEdgeColumn() {
1431 return SendMsg(2360, 0, 0);
1434 // Set the column number of the edge.
1435 // If text goes past the edge then it is highlighted.
1436 void wxStyledTextCtrl::SetEdgeColumn(int column
) {
1437 SendMsg(2361, column
, 0);
1440 // Retrieve the edge highlight mode.
1441 int wxStyledTextCtrl::GetEdgeMode() {
1442 return SendMsg(2362, 0, 0);
1445 // The edge may be displayed by a line (EDGE_LINE) or by highlighting text that
1446 // goes beyond it (EDGE_BACKGROUND) or not displayed at all (EDGE_NONE).
1447 void wxStyledTextCtrl::SetEdgeMode(int mode
) {
1448 SendMsg(2363, mode
, 0);
1451 // Retrieve the colour used in edge indication.
1452 wxColour
wxStyledTextCtrl::GetEdgeColour() {
1453 long c
= SendMsg(2364, 0, 0);
1454 return wxColourFromLong(c
);
1457 // Change the colour used in edge indication.
1458 void wxStyledTextCtrl::SetEdgeColour(const wxColour
& edgeColour
) {
1459 SendMsg(2365, wxColourAsLong(edgeColour
), 0);
1462 // Sets the current caret position to be the search anchor.
1463 void wxStyledTextCtrl::SearchAnchor() {
1464 SendMsg(2366, 0, 0);
1467 // Find some text starting at the search anchor.
1468 // Does not ensure the selection is visible.
1469 int wxStyledTextCtrl::SearchNext(int flags
, const wxString
& text
) {
1470 return SendMsg(2367, flags
, (long)text
.c_str());
1473 // Find some text starting at the search anchor and moving backwards.
1474 // Does not ensure the selection is visible.
1475 int wxStyledTextCtrl::SearchPrev(int flags
, const wxString
& text
) {
1476 return SendMsg(2368, flags
, (long)text
.c_str());
1479 // Set the way the line the caret is on is kept visible.
1480 void wxStyledTextCtrl::SetCaretPolicy(int caretPolicy
, int caretSlop
) {
1481 SendMsg(2369, caretPolicy
, caretSlop
);
1484 // Retrieves the number of lines completely visible.
1485 int wxStyledTextCtrl::LinesOnScreen() {
1486 return SendMsg(2370, 0, 0);
1489 // Set whether a pop up menu is displayed automatically when the user presses
1490 // the wrong mouse button.
1491 void wxStyledTextCtrl::UsePopUp(bool allowPopUp
) {
1492 SendMsg(2371, allowPopUp
, 0);
1495 // Is the selection a rectangular. The alternative is the more common stream selection.
1496 bool wxStyledTextCtrl::SelectionIsRectangle() {
1497 return SendMsg(2372, 0, 0) != 0;
1500 // Set the zoom level. This number of points is added to the size of all fonts.
1501 // It may be positive to magnify or negative to reduce.
1502 void wxStyledTextCtrl::SetZoom(int zoom
) {
1503 SendMsg(2373, zoom
, 0);
1506 // Retrieve the zoom level.
1507 int wxStyledTextCtrl::GetZoom() {
1508 return SendMsg(2374, 0, 0);
1511 // Create a new document object.
1512 // Starts with reference count of 1 and not selected into editor.
1513 void* wxStyledTextCtrl::CreateDocument() {
1514 return (void*)SendMsg(2375);
1517 // Extend life of document.
1518 void wxStyledTextCtrl::AddRefDocument(void* docPointer
) {
1519 SendMsg(2376, (long)docPointer
);
1522 // Release a reference to the document, deleting document if it fades to black.
1523 void wxStyledTextCtrl::ReleaseDocument(void* docPointer
) {
1524 SendMsg(2377, (long)docPointer
);
1527 // Get which document modification events are sent to the container.
1528 int wxStyledTextCtrl::GetModEventMask() {
1529 return SendMsg(2378, 0, 0);
1532 // Change internal focus flag
1533 void wxStyledTextCtrl::SetSTCFocus(bool focus
) {
1534 SendMsg(2380, focus
, 0);
1537 // Get internal focus flag
1538 bool wxStyledTextCtrl::GetSTCFocus() {
1539 return SendMsg(2381, 0, 0) != 0;
1542 // Change error status - 0 = OK
1543 void wxStyledTextCtrl::SetStatus(int statusCode
) {
1544 SendMsg(2382, statusCode
, 0);
1548 int wxStyledTextCtrl::GetStatus() {
1549 return SendMsg(2383, 0, 0);
1552 // Set whether the mouse is captured when its button is pressed
1553 void wxStyledTextCtrl::SetMouseDownCaptures(bool captures
) {
1554 SendMsg(2384, captures
, 0);
1557 // Get whether mouse gets captured
1558 bool wxStyledTextCtrl::GetMouseDownCaptures() {
1559 return SendMsg(2385, 0, 0) != 0;
1562 // Sets the cursor to one of the SC_CURSOR* values
1563 void wxStyledTextCtrl::SetCursor(int cursorType
) {
1564 SendMsg(2386, cursorType
, 0);
1568 int wxStyledTextCtrl::GetCursor() {
1569 return SendMsg(2387, 0, 0);
1572 // Move to the previous change in capitalistion
1573 void wxStyledTextCtrl::WordPartLeft() {
1574 SendMsg(2390, 0, 0);
1577 // Move to the previous change in capitalistion extending selection to new caret position.
1578 void wxStyledTextCtrl::WordPartLeftExtend() {
1579 SendMsg(2391, 0, 0);
1582 // Move to the change next in capitalistion
1583 void wxStyledTextCtrl::WordPartRight() {
1584 SendMsg(2392, 0, 0);
1587 // Move to the next change in capitalistion extending selection to new caret position.
1588 void wxStyledTextCtrl::WordPartRightExtend() {
1589 SendMsg(2393, 0, 0);
1592 // Set the way the display area is determined when a particular line is to be moved to.
1593 void wxStyledTextCtrl::SetVisiblePolicy(int visiblePolicy
, int visibleSlop
) {
1594 SendMsg(2394, visiblePolicy
, visibleSlop
);
1597 // Delete back from the current position to the start of the line
1598 void wxStyledTextCtrl::DelLineLeft() {
1599 SendMsg(2395, 0, 0);
1602 // Delete forwards from the current position to the end of the line
1603 void wxStyledTextCtrl::DelLineRight() {
1604 SendMsg(2396, 0, 0);
1607 // Start notifying the container of all key presses and commands.
1608 void wxStyledTextCtrl::StartRecord() {
1609 SendMsg(3001, 0, 0);
1612 // Stop notifying the container of all key presses and commands.
1613 void wxStyledTextCtrl::StopRecord() {
1614 SendMsg(3002, 0, 0);
1617 // Set the lexing language of the document.
1618 void wxStyledTextCtrl::SetLexer(int lexer
) {
1619 SendMsg(4001, lexer
, 0);
1622 // Retrieve the lexing language of the document.
1623 int wxStyledTextCtrl::GetLexer() {
1624 return SendMsg(4002, 0, 0);
1627 // Colourise a segment of the document using the current lexing language.
1628 void wxStyledTextCtrl::Colourise(int start
, int end
) {
1629 SendMsg(4003, start
, end
);
1632 // Set up a value that may be used by a lexer for some optional feature.
1633 void wxStyledTextCtrl::SetProperty(const wxString
& key
, const wxString
& value
) {
1634 SendMsg(4004, (long)key
.c_str(), (long)value
.c_str());
1637 // Set up the key words used by the lexer.
1638 void wxStyledTextCtrl::SetKeyWords(int keywordSet
, const wxString
& keyWords
) {
1639 SendMsg(4005, keywordSet
, (long)keyWords
.c_str());
1642 // Set the lexing language of the document based on string name.
1643 void wxStyledTextCtrl::SetLexerLanguage(const wxString
& language
) {
1644 SendMsg(4006, 0, (long)language
.c_str());
1647 // END of generated section
1648 //----------------------------------------------------------------------
1651 // Returns the line number of the line with the caret.
1652 int wxStyledTextCtrl::GetCurrentLine() {
1653 int line
= LineFromPosition(GetCurrentPos());
1658 // Extract style settings from a spec-string which is composed of one or
1659 // more of the following comma separated elements:
1661 // bold turns on bold
1662 // italic turns on italics
1663 // fore:#RRGGBB sets the foreground colour
1664 // back:#RRGGBB sets the background colour
1665 // face:[facename] sets the font face name to use
1666 // size:[num] sets the font size in points
1667 // eol turns on eol filling
1668 // underline turns on underlining
1670 void wxStyledTextCtrl::StyleSetSpec(int styleNum
, const wxString
& spec
) {
1672 wxStringTokenizer
tkz(spec
, ",");
1673 while (tkz
.HasMoreTokens()) {
1674 wxString token
= tkz
.GetNextToken();
1676 wxString option
= token
.BeforeFirst(':');
1677 wxString val
= token
.AfterFirst(':');
1679 if (option
== "bold")
1680 StyleSetBold(styleNum
, true);
1682 else if (option
== "italic")
1683 StyleSetItalic(styleNum
, true);
1685 else if (option
== "underline")
1686 StyleSetUnderline(styleNum
, true);
1688 else if (option
== "eol")
1689 StyleSetEOLFilled(styleNum
, true);
1691 else if (option
== "size") {
1693 if (val
.ToLong(&points
))
1694 StyleSetSize(styleNum
, points
);
1697 else if (option
== "face")
1698 StyleSetFaceName(styleNum
, val
);
1700 else if (option
== "fore")
1701 StyleSetForeground(styleNum
, wxColourFromSpec(val
));
1703 else if (option
== "back")
1704 StyleSetBackground(styleNum
, wxColourFromSpec(val
));
1709 // Set style size, face, bold, italic, and underline attributes from
1710 // a wxFont's attributes.
1711 void wxStyledTextCtrl::StyleSetFont(int styleNum
, wxFont
& font
) {
1712 int size
= font
.GetPointSize();
1713 wxString faceName
= font
.GetFaceName();
1714 bool bold
= font
.GetWeight() == wxBOLD
;
1715 bool italic
= font
.GetStyle() != wxNORMAL
;
1716 bool under
= font
.GetUnderlined();
1718 // TODO: add encoding/charset mapping
1719 StyleSetFontAttr(styleNum
, size
, faceName
, bold
, italic
, under
);
1722 // Set all font style attributes at once.
1723 void wxStyledTextCtrl::StyleSetFontAttr(int styleNum
, int size
,
1724 const wxString
& faceName
,
1725 bool bold
, bool italic
,
1727 StyleSetSize(styleNum
, size
);
1728 StyleSetFaceName(styleNum
, faceName
);
1729 StyleSetBold(styleNum
, bold
);
1730 StyleSetItalic(styleNum
, italic
);
1731 StyleSetUnderline(styleNum
, underline
);
1733 // TODO: add encoding/charset mapping
1737 // Perform one of the operations defined by the wxSTC_CMD_* constants.
1738 void wxStyledTextCtrl::CmdKeyExecute(int cmd
) {
1743 // Set the left and right margin in the edit area, measured in pixels.
1744 void wxStyledTextCtrl::SetMargins(int left
, int right
) {
1745 SetMarginLeft(left
);
1746 SetMarginRight(right
);
1750 // Retrieve the start and end positions of the current selection.
1751 void wxStyledTextCtrl::GetSelection(int* startPos
, int* endPos
) {
1752 if (startPos
!= NULL
)
1753 *startPos
= SendMsg(SCI_GETSELECTIONSTART
);
1755 *endPos
= SendMsg(SCI_GETSELECTIONEND
);
1759 // Retrieve the point in the window where a position is displayed.
1760 wxPoint
wxStyledTextCtrl::PointFromPosition(int pos
) {
1761 int x
= SendMsg(SCI_POINTXFROMPOSITION
, 0, pos
);
1762 int y
= SendMsg(SCI_POINTYFROMPOSITION
, 0, pos
);
1763 return wxPoint(x
, y
);
1766 // Scroll enough to make the given line visible
1767 void wxStyledTextCtrl::ScrollToLine(int line
) {
1768 m_swx
->DoScrollToLine(line
);
1772 // Scroll enough to make the given column visible
1773 void wxStyledTextCtrl::ScrollToColumn(int column
) {
1774 m_swx
->DoScrollToColumn(column
);
1779 //----------------------------------------------------------------------
1782 void wxStyledTextCtrl::OnPaint(wxPaintEvent
& evt
) {
1784 wxRegion region
= GetUpdateRegion();
1786 m_swx
->DoPaint(&dc
, region
.GetBox());
1789 void wxStyledTextCtrl::OnScrollWin(wxScrollWinEvent
& evt
) {
1790 if (evt
.GetOrientation() == wxHORIZONTAL
)
1791 m_swx
->DoHScroll(evt
.GetEventType(), evt
.GetPosition());
1793 m_swx
->DoVScroll(evt
.GetEventType(), evt
.GetPosition());
1796 void wxStyledTextCtrl::OnSize(wxSizeEvent
& evt
) {
1797 wxSize sz
= GetClientSize();
1798 m_swx
->DoSize(sz
.x
, sz
.y
);
1801 void wxStyledTextCtrl::OnMouseLeftDown(wxMouseEvent
& evt
) {
1802 wxPoint pt
= evt
.GetPosition();
1803 m_swx
->DoButtonDown(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
1804 evt
.ShiftDown(), evt
.ControlDown(), evt
.AltDown());
1807 void wxStyledTextCtrl::OnMouseMove(wxMouseEvent
& evt
) {
1808 wxPoint pt
= evt
.GetPosition();
1809 m_swx
->DoButtonMove(Point(pt
.x
, pt
.y
));
1812 void wxStyledTextCtrl::OnMouseLeftUp(wxMouseEvent
& evt
) {
1813 wxPoint pt
= evt
.GetPosition();
1814 m_swx
->DoButtonUp(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
1819 void wxStyledTextCtrl::OnContextMenu(wxContextMenuEvent
& evt
) {
1820 wxPoint pt
= evt
.GetPosition();
1821 ScreenToClient(&pt
.x
, &pt
.y
);
1822 m_swx
->DoContextMenu(Point(pt
.x
, pt
.y
));
1826 void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent
& evt
) {
1827 m_swx
->DoMouseWheel(evt
.GetWheelRotation(),
1828 evt
.GetWheelDelta(),
1829 evt
.GetLinesPerAction(),
1834 void wxStyledTextCtrl::OnChar(wxKeyEvent
& evt
) {
1835 long key
= evt
.KeyCode();
1836 if ((key
> WXK_ESCAPE
) &&
1837 (key
!= WXK_DELETE
) && (key
< 255) &&
1838 !evt
.ControlDown() && !evt
.AltDown()) {
1840 m_swx
->DoAddChar(key
);
1847 void wxStyledTextCtrl::OnKeyDown(wxKeyEvent
& evt
) {
1848 long key
= evt
.KeyCode();
1849 //key = toupper(key); //**** ????
1850 bool consumed
= FALSE
;
1851 int processed
= m_swx
->DoKeyDown(key
,
1856 if (!processed
&& !consumed
)
1860 void wxStyledTextCtrl::OnLoseFocus(wxFocusEvent
& evt
) {
1861 m_swx
->DoLoseFocus();
1864 void wxStyledTextCtrl::OnGainFocus(wxFocusEvent
& evt
) {
1865 m_swx
->DoGainFocus();
1868 void wxStyledTextCtrl::OnSysColourChanged(wxSysColourChangedEvent
& evt
) {
1869 m_swx
->DoSysColourChange();
1872 void wxStyledTextCtrl::OnEraseBackground(wxEraseEvent
& evt
) {
1873 // do nothing to help avoid flashing
1878 void wxStyledTextCtrl::OnMenu(wxCommandEvent
& evt
) {
1879 m_swx
->DoCommand(evt
.GetId());
1883 void wxStyledTextCtrl::OnListBox(wxCommandEvent
& evt
) {
1884 m_swx
->DoOnListBox();
1888 //----------------------------------------------------------------------
1889 // Turn notifications from Scintilla into events
1892 void wxStyledTextCtrl::NotifyChange() {
1893 wxStyledTextEvent
evt(wxEVT_STC_CHANGE
, GetId());
1894 GetEventHandler()->ProcessEvent(evt
);
1897 void wxStyledTextCtrl::NotifyParent(SCNotification
* _scn
) {
1898 SCNotification
& scn
= *_scn
;
1899 wxStyledTextEvent
evt(0, GetId());
1901 evt
.SetPosition(scn
.position
);
1903 evt
.SetModifiers(scn
.modifiers
);
1905 switch (scn
.nmhdr
.code
) {
1906 case SCN_STYLENEEDED
:
1907 evt
.SetEventType(wxEVT_STC_STYLENEEDED
);
1911 evt
.SetEventType(wxEVT_STC_CHARADDED
);
1914 case SCN_SAVEPOINTREACHED
:
1915 evt
.SetEventType(wxEVT_STC_SAVEPOINTREACHED
);
1918 case SCN_SAVEPOINTLEFT
:
1919 evt
.SetEventType(wxEVT_STC_SAVEPOINTLEFT
);
1922 case SCN_MODIFYATTEMPTRO
:
1923 evt
.SetEventType(wxEVT_STC_ROMODIFYATTEMPT
);
1927 evt
.SetEventType(wxEVT_STC_KEY
);
1930 case SCN_DOUBLECLICK
:
1931 evt
.SetEventType(wxEVT_STC_DOUBLECLICK
);
1935 evt
.SetEventType(wxEVT_STC_UPDATEUI
);
1939 evt
.SetEventType(wxEVT_STC_MODIFIED
);
1940 evt
.SetModificationType(scn
.modificationType
);
1942 evt
.SetText(wxString(scn
.text
, scn
.length
));
1943 evt
.SetLength(scn
.length
);
1944 evt
.SetLinesAdded(scn
.linesAdded
);
1945 evt
.SetLine(scn
.line
);
1946 evt
.SetFoldLevelNow(scn
.foldLevelNow
);
1947 evt
.SetFoldLevelPrev(scn
.foldLevelPrev
);
1950 case SCN_MACRORECORD
:
1951 evt
.SetEventType(wxEVT_STC_MACRORECORD
);
1952 evt
.SetMessage(scn
.message
);
1953 evt
.SetWParam(scn
.wParam
);
1954 evt
.SetLParam(scn
.lParam
);
1957 case SCN_MARGINCLICK
:
1958 evt
.SetEventType(wxEVT_STC_MARGINCLICK
);
1959 evt
.SetMargin(scn
.margin
);
1963 evt
.SetEventType(wxEVT_STC_NEEDSHOWN
);
1964 evt
.SetLength(scn
.length
);
1967 case SCN_POSCHANGED
:
1968 evt
.SetEventType(wxEVT_STC_POSCHANGED
);
1972 evt
.SetEventType(wxEVT_STC_PAINTED
);
1975 case SCN_USERLISTSELECTION
:
1976 evt
.SetEventType(wxEVT_STC_USERLISTSELECTION
);
1977 evt
.SetListType(scn
.listType
);
1978 evt
.SetText(scn
.text
);
1981 case SCN_URIDROPPED
:
1982 evt
.SetEventType(wxEVT_STC_URIDROPPED
);
1983 evt
.SetText(scn
.text
);
1986 case SCN_DWELLSTART
:
1987 evt
.SetEventType(wxEVT_STC_DWELLSTART
);
1993 evt
.SetEventType(wxEVT_STC_DWELLEND
);
2002 GetEventHandler()->ProcessEvent(evt
);
2007 //----------------------------------------------------------------------
2008 //----------------------------------------------------------------------
2009 //----------------------------------------------------------------------
2011 wxStyledTextEvent::wxStyledTextEvent(wxEventType commandType
, int id
)
2012 : wxCommandEvent(commandType
, id
)
2017 m_modificationType
= 0;
2022 m_foldLevelPrev
= 0;
2032 bool wxStyledTextEvent::GetShift() const { return (m_modifiers
& SCI_SHIFT
) != 0; }
2033 bool wxStyledTextEvent::GetControl() const { return (m_modifiers
& SCI_CTRL
) != 0; }
2034 bool wxStyledTextEvent::GetAlt() const { return (m_modifiers
& SCI_ALT
) != 0; }
2036 void wxStyledTextEvent::CopyObject(wxObject
& obj
) const {
2037 wxCommandEvent::CopyObject(obj
);
2039 wxStyledTextEvent
* o
= (wxStyledTextEvent
*)&obj
;
2040 o
->m_position
= m_position
;
2042 o
->m_modifiers
= m_modifiers
;
2043 o
->m_modificationType
= m_modificationType
;
2045 o
->m_length
= m_length
;
2046 o
->m_linesAdded
= m_linesAdded
;
2048 o
->m_foldLevelNow
= m_foldLevelNow
;
2049 o
->m_foldLevelPrev
= m_foldLevelPrev
;
2051 o
->m_margin
= m_margin
;
2053 o
->m_message
= m_message
;
2054 o
->m_wParam
= m_wParam
;
2055 o
->m_lParam
= m_lParam
;
2057 o
->m_listType
= m_listType
;
2063 //----------------------------------------------------------------------
2064 //----------------------------------------------------------------------