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, and in fact there
6 // is no mention of Scintilla classes at all in this header.
7 // This class delegates all method calls and events to the
8 // Scintilla objects and so forth. This allows the use of
9 // Scintilla without polluting the namespace with all the
10 // classes and itentifiers from Scintilla.
14 // Created: 13-Jan-2000
16 // Copyright: (c) 2000 by Total Control Software
17 // Licence: wxWindows license
18 /////////////////////////////////////////////////////////////////////////////
28 #ifdef WXMAKINGDLL_STC
29 #define WXDLLIMPEXP_STC WXEXPORT
30 #elif defined(WXUSINGDLL)
31 #define WXDLLIMPEXP_STC WXIMPORT
32 #else // not making nor using DLL
33 #define WXDLLIMPEXP_STC
38 // SWIG can't handle "#if" type of conditionals, only "#ifdef"
42 #if wxUSE_DRAG_AND_DROP
47 //----------------------------------------------------------------------
49 // Should a wxPopupWindow be used for the call tips and autocomplete windows?
50 #ifndef wxSTC_USE_POPUP
51 #define wxSTC_USE_POPUP 1
54 //----------------------------------------------------------------------
55 // BEGIN generated section. The following code is automatically generated
56 // by gen_iface.py. Do not edit this file. Edit stc.h.in instead
62 //-----------------------------------------
63 // Commands that can be bound to keystrokes
68 // END of generated section
69 //----------------------------------------------------------------------
71 class ScintillaWX
; // forward declare
73 struct SCNotification
;
76 extern WXDLLIMPEXP_STC
const wxChar
* wxSTCNameStr
;
77 class WXDLLIMPEXP_STC wxStyledTextCtrl
;
78 class WXDLLIMPEXP_STC wxStyledTextEvent
;
81 //----------------------------------------------------------------------
84 class WXDLLIMPEXP_STC wxStyledTextCtrl
: public wxControl
{
86 class wxStyledTextCtrl
: public wxControl
{
91 wxStyledTextCtrl(wxWindow
*parent
, wxWindowID id
,
92 const wxPoint
& pos
= wxDefaultPosition
,
93 const wxSize
& size
= wxDefaultSize
, long style
= 0,
94 const wxString
& name
= wxPySTCNameStr
);
95 %%pragma
(python
) addtomethod
= "__init__:self._setOORInfo(self)"
98 wxStyledTextCtrl(wxWindow
*parent
, wxWindowID id
,
99 const wxPoint
& pos
= wxDefaultPosition
,
100 const wxSize
& size
= wxDefaultSize
, long style
= 0,
101 const wxString
& name
= wxSTCNameStr
);
109 //----------------------------------------------------------------------
110 // BEGIN generated section. The following code is automatically generated
111 // by gen_iface.py. Do not edit this file. Edit stc.h.in instead
116 // END of generated section
117 //----------------------------------------------------------------------
121 // Returns the line number of the line with the caret.
122 int GetCurrentLine();
124 // Extract style settings from a spec-string which is composed of one or
125 // more of the following comma separated elements:
127 // bold turns on bold
128 // italic turns on italics
129 // fore:#RRGGBB sets the foreground colour
130 // back:#RRGGBB sets the background colour
131 // face:[facename] sets the font face name to use
132 // size:[num] sets the font size in points
133 // eol turns on eol filling
134 // underline turns on underlining
136 void StyleSetSpec(int styleNum
, const wxString
& spec
);
140 // Set style size, face, bold, italic, and underline attributes from
141 // a wxFont's attributes.
142 void StyleSetFont(int styleNum
, wxFont
& font
);
146 // Set all font style attributes at once.
147 void StyleSetFontAttr(int styleNum
, int size
,
148 const wxString
& faceName
,
149 bool bold
, bool italic
,
154 // Perform one of the operations defined by the wxSTC_CMD_* constants.
155 void CmdKeyExecute(int cmd
);
159 // Set the left and right margin in the edit area, measured in pixels.
160 void SetMargins(int left
, int right
);
163 // Retrieve the start and end positions of the current selection.
165 void GetSelection(int* OUTPUT
, int* OUTPUT
);
167 void GetSelection(int* startPos
, int* endPos
);
170 // Retrieve the point in the window where a position is displayed.
171 wxPoint
PointFromPosition(int pos
);
174 // Scroll enough to make the given line visible
175 void ScrollToLine(int line
);
178 // Scroll enough to make the given column visible
179 void ScrollToColumn(int column
);
182 // Send a message to Scintilla
183 long SendMsg(int msg
, long wp
=0, long lp
=0);
186 // Set the vertical scrollbar to use instead of the ont that's built-in.
187 void SetVScrollBar(wxScrollBar
* bar
) { m_vScrollBar
= bar
; }
190 // Set the horizontal scrollbar to use instead of the ont that's built-in.
191 void SetHScrollBar(wxScrollBar
* bar
) { m_hScrollBar
= bar
; }
193 // Can be used to prevent the EVT_CHAR handler from adding the char
194 bool GetLastKeydownProcessed() { return m_lastKeyDownConsumed
; }
195 void SetLastKeydownProcessed(bool val
) { m_lastKeyDownConsumed
= val
; }
197 // Write the contents of the editor to filename
198 bool SaveFile(const wxString
& filename
);
200 // Load the contents of filename into the editor
201 bool LoadFile(const wxString
& filename
);
204 // Allow for simulating a DnD DragOver
205 wxDragResult
DoDragOver(wxCoord x
, wxCoord y
, wxDragResult def
);
207 // Allow for simulating a DnD DropText
208 bool DoDropText(long x
, long y
, const wxString
& data
);
213 //----------------------------------------------------------------------
219 void OnPaint(wxPaintEvent
& evt
);
220 void OnScrollWin(wxScrollWinEvent
& evt
);
221 void OnScroll(wxScrollEvent
& evt
);
222 void OnSize(wxSizeEvent
& evt
);
223 void OnMouseLeftDown(wxMouseEvent
& evt
);
224 void OnMouseMove(wxMouseEvent
& evt
);
225 void OnMouseLeftUp(wxMouseEvent
& evt
);
226 void OnMouseRightUp(wxMouseEvent
& evt
);
227 void OnMouseMiddleUp(wxMouseEvent
& evt
);
228 void OnContextMenu(wxContextMenuEvent
& evt
);
229 void OnMouseWheel(wxMouseEvent
& evt
);
230 void OnChar(wxKeyEvent
& evt
);
231 void OnKeyDown(wxKeyEvent
& evt
);
232 void OnLoseFocus(wxFocusEvent
& evt
);
233 void OnGainFocus(wxFocusEvent
& evt
);
234 void OnSysColourChanged(wxSysColourChangedEvent
& evt
);
235 void OnEraseBackground(wxEraseEvent
& evt
);
236 void OnMenu(wxCommandEvent
& evt
);
237 void OnListBox(wxCommandEvent
& evt
);
240 // Turn notifications from Scintilla into events
242 void NotifyParent(SCNotification
* scn
);
244 DECLARE_EVENT_TABLE()
245 DECLARE_DYNAMIC_CLASS(wxStyledTextCtrl
)
250 wxStopWatch m_stopWatch
;
251 wxScrollBar
* m_vScrollBar
;
252 wxScrollBar
* m_hScrollBar
;
254 bool m_lastKeyDownConsumed
;
256 friend class ScintillaWX
;
257 friend class Platform
;
261 //----------------------------------------------------------------------
264 class WXDLLIMPEXP_STC wxStyledTextEvent
: public wxCommandEvent
{
266 class wxStyledTextEvent
: public wxCommandEvent
{
269 wxStyledTextEvent(wxEventType commandType
=0, int id
=0);
271 wxStyledTextEvent(const wxStyledTextEvent
& event
);
273 ~wxStyledTextEvent() {}
275 void SetPosition(int pos
) { m_position
= pos
; }
276 void SetKey(int k
) { m_key
= k
; }
277 void SetModifiers(int m
) { m_modifiers
= m
; }
278 void SetModificationType(int t
) { m_modificationType
= t
; }
279 void SetText(const wxString
& t
) { m_text
= t
; }
280 void SetLength(int len
) { m_length
= len
; }
281 void SetLinesAdded(int num
) { m_linesAdded
= num
; }
282 void SetLine(int val
) { m_line
= val
; }
283 void SetFoldLevelNow(int val
) { m_foldLevelNow
= val
; }
284 void SetFoldLevelPrev(int val
) { m_foldLevelPrev
= val
; }
285 void SetMargin(int val
) { m_margin
= val
; }
286 void SetMessage(int val
) { m_message
= val
; }
287 void SetWParam(int val
) { m_wParam
= val
; }
288 void SetLParam(int val
) { m_lParam
= val
; }
289 void SetListType(int val
) { m_listType
= val
; }
290 void SetX(int val
) { m_x
= val
; }
291 void SetY(int val
) { m_y
= val
; }
292 void SetDragText(const wxString
& val
) { m_dragText
= val
; }
293 void SetDragAllowMove(bool val
) { m_dragAllowMove
= val
; }
295 void SetDragResult(wxDragResult val
) { m_dragResult
= val
; }
298 int GetPosition() const { return m_position
; }
299 int GetKey() const { return m_key
; }
300 int GetModifiers() const { return m_modifiers
; }
301 int GetModificationType() const { return m_modificationType
; }
302 wxString
GetText() const { return m_text
; }
303 int GetLength() const { return m_length
; }
304 int GetLinesAdded() const { return m_linesAdded
; }
305 int GetLine() const { return m_line
; }
306 int GetFoldLevelNow() const { return m_foldLevelNow
; }
307 int GetFoldLevelPrev() const { return m_foldLevelPrev
; }
308 int GetMargin() const { return m_margin
; }
309 int GetMessage() const { return m_message
; }
310 int GetWParam() const { return m_wParam
; }
311 int GetLParam() const { return m_lParam
; }
312 int GetListType() const { return m_listType
; }
313 int GetX() const { return m_x
; }
314 int GetY() const { return m_y
; }
315 wxString
GetDragText() { return m_dragText
; }
316 bool GetDragAllowMove() { return m_dragAllowMove
; }
318 wxDragResult
GetDragResult() { return m_dragResult
; }
321 bool GetShift() const;
322 bool GetControl() const;
325 virtual wxEvent
* Clone() const { return new wxStyledTextEvent(*this); }
329 DECLARE_DYNAMIC_CLASS(wxStyledTextEvent
)
335 int m_modificationType
; // wxEVT_STC_MODIFIED
343 int m_margin
; // wxEVT_STC_MARGINCLICK
345 int m_message
; // wxEVT_STC_MACRORECORD
353 wxString m_dragText
; // wxEVT_STC_START_DRAG, wxEVT_STC_DO_DROP
354 bool m_dragAllowMove
; // wxEVT_STC_START_DRAG
356 #if wxUSE_DRAG_AND_DROP
357 wxDragResult m_dragResult
; // wxEVT_STC_DRAG_OVER,wxEVT_STC_DO_DROP
365 BEGIN_DECLARE_EVENT_TYPES()
366 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_CHANGE
, 1650)
367 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_STYLENEEDED
, 1651)
368 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_CHARADDED
, 1652)
369 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_SAVEPOINTREACHED
, 1653)
370 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_SAVEPOINTLEFT
, 1654)
371 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_ROMODIFYATTEMPT
, 1655)
372 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_KEY
, 1656)
373 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_DOUBLECLICK
, 1657)
374 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_UPDATEUI
, 1658)
375 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_MODIFIED
, 1659)
376 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_MACRORECORD
, 1660)
377 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_MARGINCLICK
, 1661)
378 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_NEEDSHOWN
, 1662)
379 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_POSCHANGED
, 1663)
380 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_PAINTED
, 1664)
381 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_USERLISTSELECTION
, 1665)
382 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_URIDROPPED
, 1666)
383 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_DWELLSTART
, 1667)
384 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_DWELLEND
, 1668)
385 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_START_DRAG
, 1669)
386 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_DRAG_OVER
, 1670)
387 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_DO_DROP
, 1671)
388 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_ZOOM
, 1672)
389 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_HOTSPOT_CLICK
, 1673)
390 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_HOTSPOT_DCLICK
, 1674)
391 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_CALLTIP_CLICK
, 1675)
392 END_DECLARE_EVENT_TYPES()
396 wxEVT_STC_STYLENEEDED
,
398 wxEVT_STC_SAVEPOINTREACHED
,
399 wxEVT_STC_SAVEPOINTLEFT
,
400 wxEVT_STC_ROMODIFYATTEMPT
,
402 wxEVT_STC_DOUBLECLICK
,
405 wxEVT_STC_MACRORECORD
,
406 wxEVT_STC_MARGINCLICK
,
408 wxEVT_STC_POSCHANGED
,
410 wxEVT_STC_USERLISTSELECTION
,
411 wxEVT_STC_URIDROPPED
,
412 wxEVT_STC_DWELLSTART
,
414 wxEVT_STC_START_DRAG
,
418 wxEVT_STC_HOTSPOT_CLICK
,
419 wxEVT_STC_HOTSPOT_DCLICK
,
420 wxEVT_STC_CALLTIP_CLICK
427 typedef void (wxEvtHandler::*wxStyledTextEventFunction
)(wxStyledTextEvent
&);
429 #define EVT_STC_CHANGE(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_CHANGE, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
430 #define EVT_STC_STYLENEEDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_STYLENEEDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
431 #define EVT_STC_CHARADDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_CHARADDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
432 #define EVT_STC_SAVEPOINTREACHED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_SAVEPOINTREACHED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
433 #define EVT_STC_SAVEPOINTLEFT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_SAVEPOINTLEFT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
434 #define EVT_STC_ROMODIFYATTEMPT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_ROMODIFYATTEMPT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
435 #define EVT_STC_KEY(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_KEY, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
436 #define EVT_STC_DOUBLECLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DOUBLECLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
437 #define EVT_STC_UPDATEUI(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_UPDATEUI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
438 #define EVT_STC_MODIFIED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_MODIFIED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
439 #define EVT_STC_MACRORECORD(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_MACRORECORD, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
440 #define EVT_STC_MARGINCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_MARGINCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
441 #define EVT_STC_NEEDSHOWN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_NEEDSHOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
442 #define EVT_STC_POSCHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_POSCHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
443 #define EVT_STC_PAINTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_PAINTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
444 #define EVT_STC_USERLISTSELECTION(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_USERLISTSELECTION, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
445 #define EVT_STC_URIDROPPED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_URIDROPPED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
446 #define EVT_STC_DWELLSTART(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DWELLSTART, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
447 #define EVT_STC_DWELLEND(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DWELLEND, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
448 #define EVT_STC_START_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_START_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
449 #define EVT_STC_DRAG_OVER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DRAG_OVER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
450 #define EVT_STC_DO_DROP(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DO_DROP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
451 #define EVT_STC_ZOOM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_ZOOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
452 #define EVT_STC_HOTSPOT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_HOTSPOT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
453 #define EVT_STC_HOTSPOT_DCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_HOTSPOT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
454 #define EVT_STC_CALLTIP_CLICK(id, fn)) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_CALLTIP_CLICK id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
458 //----------------------------------------------------------------------
459 // Utility functions used within wxSTC
463 inline wxString
stc2wx(const char* str
) {
465 return wxString(str
, wxConvUTF8
);
467 return wxString(str
);
472 wxString
stc2wx(const char* str
, size_t len
);
474 inline wxString
stc2wx(const char* str
, size_t len
) {
475 return wxString(str
, len
);
481 inline const wxWX2MBbuf
wx2stc(const wxString
& str
) {
482 return str
.mb_str(wxConvUTF8
);
485 inline const wxWX2MBbuf
wx2stc(const wxString
& str
) {
486 return str
.mbc_str();
493 //----------------------------------------------------------------------