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 //----------------------------------------------------------------------
40 // Should a wxPopupWindow be used for the call tips and autocomplete windows?
41 #ifndef wxSTC_USE_POPUP
42 #define wxSTC_USE_POPUP 1
45 //----------------------------------------------------------------------
46 // BEGIN generated section. The following code is automatically generated
47 // by gen_iface.py. Do not edit this file. Edit stc.h.in instead
53 //-----------------------------------------
54 // Commands that can be bound to keystrokes
59 // END of generated section
60 //----------------------------------------------------------------------
62 class ScintillaWX
; // forward declare
64 struct SCNotification
;
67 extern WXDLLIMPEXP_STC
const wxChar
* wxSTCNameStr
;
68 class WXDLLIMPEXP_STC wxStyledTextCtrl
;
69 class WXDLLIMPEXP_STC wxStyledTextEvent
;
72 //----------------------------------------------------------------------
75 class WXDLLIMPEXP_STC wxStyledTextCtrl
: public wxControl
{
77 class wxStyledTextCtrl
: public wxControl
{
82 wxStyledTextCtrl(wxWindow
*parent
, wxWindowID id
,
83 const wxPoint
& pos
= wxDefaultPosition
,
84 const wxSize
& size
= wxDefaultSize
, long style
= 0,
85 const wxString
& name
= wxPySTCNameStr
);
86 %%pragma
(python
) addtomethod
= "__init__:self._setOORInfo(self)"
89 wxStyledTextCtrl(wxWindow
*parent
, wxWindowID id
,
90 const wxPoint
& pos
= wxDefaultPosition
,
91 const wxSize
& size
= wxDefaultSize
, long style
= 0,
92 const wxString
& name
= wxSTCNameStr
);
100 //----------------------------------------------------------------------
101 // BEGIN generated section. The following code is automatically generated
102 // by gen_iface.py. Do not edit this file. Edit stc.h.in instead
107 // END of generated section
108 //----------------------------------------------------------------------
112 // Returns the line number of the line with the caret.
113 int GetCurrentLine();
115 // Extract style settings from a spec-string which is composed of one or
116 // more of the following comma separated elements:
118 // bold turns on bold
119 // italic turns on italics
120 // fore:#RRGGBB sets the foreground colour
121 // back:#RRGGBB sets the background colour
122 // face:[facename] sets the font face name to use
123 // size:[num] sets the font size in points
124 // eol turns on eol filling
125 // underline turns on underlining
127 void StyleSetSpec(int styleNum
, const wxString
& spec
);
131 // Set style size, face, bold, italic, and underline attributes from
132 // a wxFont's attributes.
133 void StyleSetFont(int styleNum
, wxFont
& font
);
137 // Set all font style attributes at once.
138 void StyleSetFontAttr(int styleNum
, int size
,
139 const wxString
& faceName
,
140 bool bold
, bool italic
,
145 // Perform one of the operations defined by the wxSTC_CMD_* constants.
146 void CmdKeyExecute(int cmd
);
150 // Set the left and right margin in the edit area, measured in pixels.
151 void SetMargins(int left
, int right
);
154 // Retrieve the start and end positions of the current selection.
156 void GetSelection(int* OUTPUT
, int* OUTPUT
);
158 void GetSelection(int* startPos
, int* endPos
);
161 // Retrieve the point in the window where a position is displayed.
162 wxPoint
PointFromPosition(int pos
);
165 // Scroll enough to make the given line visible
166 void ScrollToLine(int line
);
169 // Scroll enough to make the given column visible
170 void ScrollToColumn(int column
);
173 // Send a message to Scintilla
174 long SendMsg(int msg
, long wp
=0, long lp
=0);
177 // Set the vertical scrollbar to use instead of the ont that's built-in.
178 void SetVScrollBar(wxScrollBar
* bar
) { m_vScrollBar
= bar
; }
181 // Set the horizontal scrollbar to use instead of the ont that's built-in.
182 void SetHScrollBar(wxScrollBar
* bar
) { m_hScrollBar
= bar
; }
184 // Can be used to prevent the EVT_CHAR handler from adding the char
185 bool GetLastKeydownProcessed() { return m_lastKeyDownConsumed
; }
186 void SetLastKeydownProcessed(bool val
) { m_lastKeyDownConsumed
= val
; }
188 // Write the contents of the editor to filename
189 bool SaveFile(const wxString
& filename
);
191 // Load the contents of filename into the editor
192 bool LoadFile(const wxString
& filename
);
195 //----------------------------------------------------------------------
201 void OnPaint(wxPaintEvent
& evt
);
202 void OnScrollWin(wxScrollWinEvent
& evt
);
203 void OnScroll(wxScrollEvent
& evt
);
204 void OnSize(wxSizeEvent
& evt
);
205 void OnMouseLeftDown(wxMouseEvent
& evt
);
206 void OnMouseMove(wxMouseEvent
& evt
);
207 void OnMouseLeftUp(wxMouseEvent
& evt
);
208 void OnMouseRightUp(wxMouseEvent
& evt
);
209 void OnMouseMiddleUp(wxMouseEvent
& evt
);
210 void OnContextMenu(wxContextMenuEvent
& evt
);
211 void OnMouseWheel(wxMouseEvent
& evt
);
212 void OnChar(wxKeyEvent
& evt
);
213 void OnKeyDown(wxKeyEvent
& evt
);
214 void OnLoseFocus(wxFocusEvent
& evt
);
215 void OnGainFocus(wxFocusEvent
& evt
);
216 void OnSysColourChanged(wxSysColourChangedEvent
& evt
);
217 void OnEraseBackground(wxEraseEvent
& evt
);
218 void OnMenu(wxCommandEvent
& evt
);
219 void OnListBox(wxCommandEvent
& evt
);
222 // Turn notifications from Scintilla into events
224 void NotifyParent(SCNotification
* scn
);
226 DECLARE_EVENT_TABLE()
227 DECLARE_DYNAMIC_CLASS(wxStyledTextCtrl
)
232 wxStopWatch m_stopWatch
;
233 wxScrollBar
* m_vScrollBar
;
234 wxScrollBar
* m_hScrollBar
;
236 bool m_lastKeyDownConsumed
;
238 friend class ScintillaWX
;
239 friend class Platform
;
243 //----------------------------------------------------------------------
245 // SWIG can't handle "#if" type of conditionals, only "#ifdef"
247 #define STC_USE_DND 1
249 #if wxUSE_DRAG_AND_DROP
250 #define STC_USE_DND 1
255 class WXDLLIMPEXP_STC wxStyledTextEvent
: public wxCommandEvent
{
257 class wxStyledTextEvent
: public wxCommandEvent
{
260 wxStyledTextEvent(wxEventType commandType
=0, int id
=0);
262 wxStyledTextEvent(const wxStyledTextEvent
& event
);
264 ~wxStyledTextEvent() {}
266 void SetPosition(int pos
) { m_position
= pos
; }
267 void SetKey(int k
) { m_key
= k
; }
268 void SetModifiers(int m
) { m_modifiers
= m
; }
269 void SetModificationType(int t
) { m_modificationType
= t
; }
270 void SetText(const wxString
& t
) { m_text
= t
; }
271 void SetLength(int len
) { m_length
= len
; }
272 void SetLinesAdded(int num
) { m_linesAdded
= num
; }
273 void SetLine(int val
) { m_line
= val
; }
274 void SetFoldLevelNow(int val
) { m_foldLevelNow
= val
; }
275 void SetFoldLevelPrev(int val
) { m_foldLevelPrev
= val
; }
276 void SetMargin(int val
) { m_margin
= val
; }
277 void SetMessage(int val
) { m_message
= val
; }
278 void SetWParam(int val
) { m_wParam
= val
; }
279 void SetLParam(int val
) { m_lParam
= val
; }
280 void SetListType(int val
) { m_listType
= val
; }
281 void SetX(int val
) { m_x
= val
; }
282 void SetY(int val
) { m_y
= val
; }
283 void SetDragText(const wxString
& val
) { m_dragText
= val
; }
284 void SetDragAllowMove(bool val
) { m_dragAllowMove
= val
; }
286 void SetDragResult(wxDragResult val
) { m_dragResult
= val
; }
289 int GetPosition() const { return m_position
; }
290 int GetKey() const { return m_key
; }
291 int GetModifiers() const { return m_modifiers
; }
292 int GetModificationType() const { return m_modificationType
; }
293 wxString
GetText() const { return m_text
; }
294 int GetLength() const { return m_length
; }
295 int GetLinesAdded() const { return m_linesAdded
; }
296 int GetLine() const { return m_line
; }
297 int GetFoldLevelNow() const { return m_foldLevelNow
; }
298 int GetFoldLevelPrev() const { return m_foldLevelPrev
; }
299 int GetMargin() const { return m_margin
; }
300 int GetMessage() const { return m_message
; }
301 int GetWParam() const { return m_wParam
; }
302 int GetLParam() const { return m_lParam
; }
303 int GetListType() const { return m_listType
; }
304 int GetX() const { return m_x
; }
305 int GetY() const { return m_y
; }
306 wxString
GetDragText() { return m_dragText
; }
307 bool GetDragAllowMove() { return m_dragAllowMove
; }
309 wxDragResult
GetDragResult() { return m_dragResult
; }
312 bool GetShift() const;
313 bool GetControl() const;
316 virtual wxEvent
* Clone() const { return new wxStyledTextEvent(*this); }
320 DECLARE_DYNAMIC_CLASS(wxStyledTextEvent
)
326 int m_modificationType
; // wxEVT_STC_MODIFIED
334 int m_margin
; // wxEVT_STC_MARGINCLICK
336 int m_message
; // wxEVT_STC_MACRORECORD
344 wxString m_dragText
; // wxEVT_STC_START_DRAG, wxEVT_STC_DO_DROP
345 bool m_dragAllowMove
; // wxEVT_STC_START_DRAG
347 #if wxUSE_DRAG_AND_DROP
348 wxDragResult m_dragResult
; // wxEVT_STC_DRAG_OVER,wxEVT_STC_DO_DROP
356 BEGIN_DECLARE_EVENT_TYPES()
357 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_CHANGE
, 1650)
358 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_STYLENEEDED
, 1651)
359 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_CHARADDED
, 1652)
360 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_SAVEPOINTREACHED
, 1653)
361 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_SAVEPOINTLEFT
, 1654)
362 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_ROMODIFYATTEMPT
, 1655)
363 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_KEY
, 1656)
364 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_DOUBLECLICK
, 1657)
365 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_UPDATEUI
, 1658)
366 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_MODIFIED
, 1659)
367 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_MACRORECORD
, 1660)
368 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_MARGINCLICK
, 1661)
369 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_NEEDSHOWN
, 1662)
370 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_POSCHANGED
, 1663)
371 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_PAINTED
, 1664)
372 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_USERLISTSELECTION
, 1665)
373 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_URIDROPPED
, 1666)
374 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_DWELLSTART
, 1667)
375 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_DWELLEND
, 1668)
376 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_START_DRAG
, 1669)
377 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_DRAG_OVER
, 1670)
378 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_DO_DROP
, 1671)
379 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_ZOOM
, 1672)
380 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_HOTSPOT_CLICK
, 1673)
381 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_HOTSPOT_DCLICK
, 1674)
382 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_STC
, wxEVT_STC_CALLTIP_CLICK
, 1675)
383 END_DECLARE_EVENT_TYPES()
387 wxEVT_STC_STYLENEEDED
,
389 wxEVT_STC_SAVEPOINTREACHED
,
390 wxEVT_STC_SAVEPOINTLEFT
,
391 wxEVT_STC_ROMODIFYATTEMPT
,
393 wxEVT_STC_DOUBLECLICK
,
396 wxEVT_STC_MACRORECORD
,
397 wxEVT_STC_MARGINCLICK
,
399 wxEVT_STC_POSCHANGED
,
401 wxEVT_STC_USERLISTSELECTION
,
402 wxEVT_STC_URIDROPPED
,
403 wxEVT_STC_DWELLSTART
,
405 wxEVT_STC_START_DRAG
,
409 wxEVT_STC_HOTSPOT_CLICK
,
410 wxEVT_STC_HOTSPOT_DCLICK
,
411 wxEVT_STC_CALLTIP_CLICK
418 typedef void (wxEvtHandler::*wxStyledTextEventFunction
)(wxStyledTextEvent
&);
420 #define EVT_STC_CHANGE(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_CHANGE, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
421 #define EVT_STC_STYLENEEDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_STYLENEEDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
422 #define EVT_STC_CHARADDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_CHARADDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
423 #define EVT_STC_SAVEPOINTREACHED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_SAVEPOINTREACHED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
424 #define EVT_STC_SAVEPOINTLEFT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_SAVEPOINTLEFT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
425 #define EVT_STC_ROMODIFYATTEMPT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_ROMODIFYATTEMPT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
426 #define EVT_STC_KEY(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_KEY, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
427 #define EVT_STC_DOUBLECLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DOUBLECLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
428 #define EVT_STC_UPDATEUI(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_UPDATEUI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
429 #define EVT_STC_MODIFIED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_MODIFIED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
430 #define EVT_STC_MACRORECORD(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_MACRORECORD, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
431 #define EVT_STC_MARGINCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_MARGINCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
432 #define EVT_STC_NEEDSHOWN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_NEEDSHOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
433 #define EVT_STC_POSCHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_POSCHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
434 #define EVT_STC_PAINTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_PAINTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
435 #define EVT_STC_USERLISTSELECTION(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_USERLISTSELECTION, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
436 #define EVT_STC_URIDROPPED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_URIDROPPED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
437 #define EVT_STC_DWELLSTART(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DWELLSTART, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
438 #define EVT_STC_DWELLEND(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DWELLEND, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
439 #define EVT_STC_START_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_START_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
440 #define EVT_STC_DRAG_OVER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DRAG_OVER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
441 #define EVT_STC_DO_DROP(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DO_DROP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
442 #define EVT_STC_ZOOM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_ZOOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
443 #define EVT_STC_HOTSPOT_CLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_HOTSPOT_CLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
444 #define EVT_STC_HOTSPOT_DCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_HOTSPOT_DCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
445 #define EVT_STC_CALLTIP_CLICK(id, fn)) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_CALLTIP_CLICK id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
449 //----------------------------------------------------------------------
450 // Utility functions used within wxSTC
454 inline wxString
stc2wx(const char* str
) {
456 return wxString(str
, wxConvUTF8
);
458 return wxString(str
);
463 wxString
stc2wx(const char* str
, size_t len
);
465 inline wxString
stc2wx(const char* str
, size_t len
) {
466 return wxString(str
, len
);
472 inline const wxWX2MBbuf
wx2stc(const wxString
& str
) {
473 return str
.mb_str(wxConvUTF8
);
476 inline const wxWX2MBbuf
wx2stc(const wxString
& str
) {
477 return str
.mbc_str();
484 //----------------------------------------------------------------------