]>
Commit | Line | Data |
---|---|---|
f97d84a6 RD |
1 | //////////////////////////////////////////////////////////////////////////// |
2 | // Name: stc.h | |
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. | |
11 | // | |
12 | // Author: Robin Dunn | |
13 | // | |
14 | // Created: 13-Jan-2000 | |
15 | // RCS-ID: $Id$ | |
16 | // Copyright: (c) 2000 by Total Control Software | |
17 | // Licence: wxWindows license | |
18 | ///////////////////////////////////////////////////////////////////////////// | |
19 | ||
20 | #ifndef __stc_h__ | |
21 | #define __stc_h__ | |
22 | ||
23 | ||
24 | #include <wx/wx.h> | |
a29a241f | 25 | #include <wx/dnd.h> |
f97d84a6 RD |
26 | |
27 | //---------------------------------------------------------------------- | |
28 | // BEGIN generated section. The following code is automatically generated | |
29 | // by gen_iface.py. Do not edit this file. Edit stc.h.in instead | |
30 | // and regenerate | |
31 | ||
32 | %(VALUES)s | |
33 | ||
34 | // END of generated section | |
f97d84a6 RD |
35 | //---------------------------------------------------------------------- |
36 | ||
37 | class ScintillaWX; // forward declare | |
38 | class WordList; | |
39 | struct SCNotification; | |
40 | ||
41 | ||
42 | extern const wxChar* wxSTCNameStr; | |
43 | ||
44 | //---------------------------------------------------------------------- | |
45 | ||
46 | class wxStyledTextCtrl : public wxControl { | |
47 | public: | |
48 | ||
49 | #ifdef SWIG | |
50 | wxStyledTextCtrl(wxWindow *parent, wxWindowID id, | |
51 | const wxPoint& pos = wxDefaultPosition, | |
52 | const wxSize& size = wxDefaultSize, long style = 0, | |
53 | const char* name = "styledtext"); | |
0122b7e3 RD |
54 | %%pragma(python) addtomethod = "__init__:self._setOORInfo(self)" |
55 | ||
f97d84a6 RD |
56 | #else |
57 | wxStyledTextCtrl(wxWindow *parent, wxWindowID id, | |
58 | const wxPoint& pos = wxDefaultPosition, | |
59 | const wxSize& size = wxDefaultSize, long style = 0, | |
60 | const wxString& name = wxSTCNameStr); | |
61 | #endif | |
62 | ||
63 | ||
64 | #ifndef SWIG | |
65 | ~wxStyledTextCtrl(); | |
66 | #endif | |
67 | ||
68 | //---------------------------------------------------------------------- | |
69 | // BEGIN generated section. The following code is automatically generated | |
70 | // by gen_iface.py. Do not edit this file. Edit stc.h.in instead | |
71 | // and regenerate | |
72 | ||
73 | %(METHOD_DEFS)s | |
74 | ||
75 | // END of generated section | |
76 | //---------------------------------------------------------------------- | |
77 | // Others... | |
78 | ||
79 | ||
80 | // Returns the line number of the line with the caret. | |
81 | int GetCurrentLine(); | |
82 | ||
83 | // Extract style settings from a spec-string which is composed of one or | |
84 | // more of the following comma separated elements: | |
85 | // | |
86 | // bold turns on bold | |
87 | // italic turns on italics | |
88 | // fore:#RRGGBB sets the foreground colour | |
89 | // back:#RRGGBB sets the background colour | |
90 | // face:[facename] sets the font face name to use | |
91 | // size:[num] sets the font size in points | |
92 | // eol turns on eol filling | |
93 | // underline turns on underlining | |
94 | // | |
95 | void StyleSetSpec(int styleNum, const wxString& spec); | |
96 | ||
97 | ||
98 | ||
99 | // Set style size, face, bold, italic, and underline attributes from | |
100 | // a wxFont's attributes. | |
101 | void StyleSetFont(int styleNum, wxFont& font); | |
102 | ||
103 | ||
104 | ||
105 | // Set all font style attributes at once. | |
106 | void StyleSetFontAttr(int styleNum, int size, | |
107 | const wxString& faceName, | |
108 | bool bold, bool italic, | |
109 | bool underline); | |
110 | ||
111 | ||
112 | ||
113 | // Perform one of the operations defined by the wxSTC_CMD_* constants. | |
114 | void CmdKeyExecute(int cmd); | |
115 | ||
116 | ||
117 | ||
118 | // Set the left and right margin in the edit area, measured in pixels. | |
119 | void SetMargins(int left, int right); | |
120 | ||
121 | ||
122 | // Retrieve the start and end positions of the current selection. | |
123 | #ifdef SWIG | |
124 | void GetSelection(int* OUTPUT, int* OUTPUT); | |
125 | #else | |
126 | void GetSelection(int* startPos, int* endPos); | |
127 | #endif | |
128 | ||
129 | // Retrieve the point in the window where a position is displayed. | |
130 | wxPoint PointFromPosition(int pos); | |
131 | ||
132 | ||
133 | // Scroll enough to make the given line visible | |
134 | void ScrollToLine(int line); | |
135 | ||
136 | ||
137 | // Scroll enough to make the given column visible | |
138 | void ScrollToColumn(int column); | |
139 | ||
65ec6247 RD |
140 | |
141 | // Send a message to Scintilla | |
142 | long SendMsg(int msg, long wp=0, long lp=0); | |
143 | ||
5fa4613c RD |
144 | |
145 | // Set the vertical scrollbar to use instead of the ont that's built-in. | |
146 | void SetVScrollBar(wxScrollBar* bar) { m_vScrollBar = bar; } | |
147 | ||
148 | ||
149 | // Set the horizontal scrollbar to use instead of the ont that's built-in. | |
150 | void SetHScrollBar(wxScrollBar* bar) { m_hScrollBar = bar; } | |
151 | ||
f97d84a6 RD |
152 | //---------------------------------------------------------------------- |
153 | ||
154 | ||
155 | #ifndef SWIG | |
156 | private: | |
157 | // Event handlers | |
158 | void OnPaint(wxPaintEvent& evt); | |
159 | void OnScrollWin(wxScrollWinEvent& evt); | |
5fa4613c | 160 | void OnScroll(wxScrollEvent& evt); |
f97d84a6 RD |
161 | void OnSize(wxSizeEvent& evt); |
162 | void OnMouseLeftDown(wxMouseEvent& evt); | |
163 | void OnMouseMove(wxMouseEvent& evt); | |
164 | void OnMouseLeftUp(wxMouseEvent& evt); | |
ddf2da08 | 165 | void OnMouseRightUp(wxMouseEvent& evt); |
65ec6247 | 166 | void OnContextMenu(wxContextMenuEvent& evt); |
37d62433 | 167 | void OnMouseWheel(wxMouseEvent& evt); |
f97d84a6 RD |
168 | void OnChar(wxKeyEvent& evt); |
169 | void OnKeyDown(wxKeyEvent& evt); | |
170 | void OnLoseFocus(wxFocusEvent& evt); | |
171 | void OnGainFocus(wxFocusEvent& evt); | |
172 | void OnSysColourChanged(wxSysColourChangedEvent& evt); | |
173 | void OnEraseBackground(wxEraseEvent& evt); | |
174 | void OnMenu(wxCommandEvent& evt); | |
175 | void OnListBox(wxCommandEvent& evt); | |
176 | ||
177 | ||
178 | // Turn notifications from Scintilla into events | |
179 | void NotifyChange(); | |
180 | void NotifyParent(SCNotification* scn); | |
181 | ||
a29a241f | 182 | |
f97d84a6 RD |
183 | private: |
184 | DECLARE_EVENT_TABLE() | |
185 | DECLARE_CLASS(wxStyledTextCtrl) | |
186 | ||
187 | ScintillaWX* m_swx; | |
188 | wxStopWatch m_stopWatch; | |
5fa4613c RD |
189 | wxScrollBar* m_vScrollBar; |
190 | wxScrollBar* m_hScrollBar; | |
f97d84a6 | 191 | |
d6582821 | 192 | bool m_lastKeyDownConsumed; |
f97d84a6 RD |
193 | |
194 | friend class ScintillaWX; | |
195 | friend class Platform; | |
196 | #endif | |
197 | }; | |
198 | ||
199 | //---------------------------------------------------------------------- | |
200 | ||
201 | class wxStyledTextEvent : public wxCommandEvent { | |
202 | public: | |
203 | wxStyledTextEvent(wxEventType commandType=0, int id=0); | |
4161723f RD |
204 | #ifndef SWIG |
205 | wxStyledTextEvent(const wxStyledTextEvent& event); | |
206 | #endif | |
f97d84a6 RD |
207 | ~wxStyledTextEvent() {} |
208 | ||
a29a241f RD |
209 | void SetPosition(int pos) { m_position = pos; } |
210 | void SetKey(int k) { m_key = k; } | |
211 | void SetModifiers(int m) { m_modifiers = m; } | |
212 | void SetModificationType(int t) { m_modificationType = t; } | |
213 | void SetText(const char* t) { m_text = t; } | |
214 | void SetLength(int len) { m_length = len; } | |
215 | void SetLinesAdded(int num) { m_linesAdded = num; } | |
216 | void SetLine(int val) { m_line = val; } | |
217 | void SetFoldLevelNow(int val) { m_foldLevelNow = val; } | |
218 | void SetFoldLevelPrev(int val) { m_foldLevelPrev = val; } | |
219 | void SetMargin(int val) { m_margin = val; } | |
220 | void SetMessage(int val) { m_message = val; } | |
221 | void SetWParam(int val) { m_wParam = val; } | |
222 | void SetLParam(int val) { m_lParam = val; } | |
223 | void SetListType(int val) { m_listType = val; } | |
224 | void SetX(int val) { m_x = val; } | |
225 | void SetY(int val) { m_y = val; } | |
226 | void SetDragText(const wxString& val) { m_dragText = val; } | |
227 | void SetDragAllowMove(bool val) { m_dragAllowMove = val; } | |
228 | void SetDragResult(wxDragResult val) { m_dragResult = val; } | |
f97d84a6 RD |
229 | |
230 | int GetPosition() const { return m_position; } | |
231 | int GetKey() const { return m_key; } | |
232 | int GetModifiers() const { return m_modifiers; } | |
233 | int GetModificationType() const { return m_modificationType; } | |
234 | wxString GetText() const { return m_text; } | |
235 | int GetLength() const { return m_length; } | |
236 | int GetLinesAdded() const { return m_linesAdded; } | |
237 | int GetLine() const { return m_line; } | |
238 | int GetFoldLevelNow() const { return m_foldLevelNow; } | |
239 | int GetFoldLevelPrev() const { return m_foldLevelPrev; } | |
240 | int GetMargin() const { return m_margin; } | |
241 | int GetMessage() const { return m_message; } | |
242 | int GetWParam() const { return m_wParam; } | |
243 | int GetLParam() const { return m_lParam; } | |
65ec6247 RD |
244 | int GetListType() const { return m_listType; } |
245 | int GetX() const { return m_x; } | |
246 | int GetY() const { return m_y; } | |
a29a241f RD |
247 | wxString GetDragText() { return m_dragText; } |
248 | bool GetDragAllowMove() { return m_dragAllowMove; } | |
249 | wxDragResult GetDragResult() { return m_dragResult; } | |
f97d84a6 RD |
250 | |
251 | bool GetShift() const; | |
252 | bool GetControl() const; | |
253 | bool GetAlt() const; | |
254 | ||
5fa4613c | 255 | virtual wxEvent* Clone() const { return new wxStyledTextEvent(*this); } |
f97d84a6 RD |
256 | |
257 | #ifndef SWIG | |
258 | private: | |
259 | DECLARE_DYNAMIC_CLASS(wxStyledTextEvent) | |
260 | ||
261 | int m_position; | |
262 | int m_key; | |
263 | int m_modifiers; | |
264 | ||
265 | int m_modificationType; // wxEVT_STC_MODIFIED | |
266 | wxString m_text; | |
267 | int m_length; | |
268 | int m_linesAdded; | |
269 | int m_line; | |
270 | int m_foldLevelNow; | |
271 | int m_foldLevelPrev; | |
272 | ||
273 | int m_margin; // wxEVT_STC_MARGINCLICK | |
274 | ||
275 | int m_message; // wxEVT_STC_MACRORECORD | |
276 | int m_wParam; | |
277 | int m_lParam; | |
65ec6247 RD |
278 | |
279 | int m_listType; | |
280 | int m_x; | |
281 | int m_y; | |
a29a241f RD |
282 | |
283 | wxString m_dragText; // wxEVT_STC_START_DRAG, wxEVT_STC_DO_DROP | |
284 | bool m_dragAllowMove; // wxEVT_STC_START_DRAG | |
285 | ||
286 | wxDragResult m_dragResult; // wxEVT_STC_DRAG_OVER,wxEVT_STC_DO_DROP | |
f97d84a6 RD |
287 | #endif |
288 | }; | |
289 | ||
d25f5fbb RD |
290 | #ifndef SWIG |
291 | BEGIN_DECLARE_EVENT_TYPES() | |
65ec6247 RD |
292 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_CHANGE, 1650) |
293 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_STYLENEEDED, 1651) | |
294 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_CHARADDED, 1652) | |
295 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_SAVEPOINTREACHED, 1653) | |
296 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_SAVEPOINTLEFT, 1654) | |
297 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_ROMODIFYATTEMPT, 1655) | |
298 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_KEY, 1656) | |
299 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_DOUBLECLICK, 1657) | |
300 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_UPDATEUI, 1658) | |
301 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_MODIFIED, 1659) | |
302 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_MACRORECORD, 1660) | |
303 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_MARGINCLICK, 1661) | |
304 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_NEEDSHOWN, 1662) | |
305 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_POSCHANGED, 1663) | |
306 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_PAINTED, 1664) | |
307 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_USERLISTSELECTION, 1665) | |
308 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_URIDROPPED, 1666) | |
309 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_DWELLSTART, 1667) | |
310 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_DWELLEND, 1668) | |
a29a241f RD |
311 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_START_DRAG, 1669) |
312 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_DRAG_OVER, 1670) | |
313 | DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_DO_DROP, 1671) | |
d25f5fbb RD |
314 | END_DECLARE_EVENT_TYPES() |
315 | #else | |
316 | enum { | |
317 | wxEVT_STC_CHANGE, | |
318 | wxEVT_STC_STYLENEEDED, | |
319 | wxEVT_STC_CHARADDED, | |
d25f5fbb RD |
320 | wxEVT_STC_SAVEPOINTREACHED, |
321 | wxEVT_STC_SAVEPOINTLEFT, | |
322 | wxEVT_STC_ROMODIFYATTEMPT, | |
65ec6247 | 323 | wxEVT_STC_KEY, |
d25f5fbb | 324 | wxEVT_STC_DOUBLECLICK, |
65ec6247 | 325 | wxEVT_STC_UPDATEUI, |
d25f5fbb | 326 | wxEVT_STC_MODIFIED, |
d25f5fbb RD |
327 | wxEVT_STC_MACRORECORD, |
328 | wxEVT_STC_MARGINCLICK, | |
329 | wxEVT_STC_NEEDSHOWN, | |
65ec6247 RD |
330 | wxEVT_STC_POSCHANGED, |
331 | wxEVT_STC_PAINTED, | |
332 | wxEVT_STC_USERLISTSELECTION, | |
333 | wxEVT_STC_URIDROPPED, | |
334 | wxEVT_STC_DWELLSTART, | |
335 | wxEVT_STC_DWELLEND, | |
a29a241f RD |
336 | wxEVT_STC_START_DRAG, |
337 | wxEVT_STC_DRAG_OVER, | |
338 | wxEVT_STC_DO_DROP, | |
d25f5fbb RD |
339 | }; |
340 | #endif | |
f97d84a6 | 341 | |
f97d84a6 RD |
342 | |
343 | ||
344 | #ifndef SWIG | |
345 | typedef void (wxEvtHandler::*wxStyledTextEventFunction)(wxStyledTextEvent&); | |
346 | ||
65ec6247 RD |
347 | #define EVT_STC_CHANGE(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_CHANGE, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), |
348 | #define EVT_STC_STYLENEEDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_STYLENEEDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
349 | #define EVT_STC_CHARADDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_CHARADDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
350 | #define EVT_STC_SAVEPOINTREACHED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_SAVEPOINTREACHED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
351 | #define EVT_STC_SAVEPOINTLEFT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_SAVEPOINTLEFT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
352 | #define EVT_STC_ROMODIFYATTEMPT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_ROMODIFYATTEMPT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
353 | #define EVT_STC_KEY(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_KEY, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
354 | #define EVT_STC_DOUBLECLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DOUBLECLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
355 | #define EVT_STC_UPDATEUI(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_UPDATEUI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
356 | #define EVT_STC_MODIFIED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_MODIFIED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
357 | #define EVT_STC_MACRORECORD(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_MACRORECORD, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
358 | #define EVT_STC_MARGINCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_MARGINCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
359 | #define EVT_STC_NEEDSHOWN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_NEEDSHOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
360 | #define EVT_STC_POSCHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_POSCHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
361 | #define EVT_STC_PAINTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_PAINTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
362 | #define EVT_STC_USERLISTSELECTION(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_USERLISTSELECTION, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
363 | #define EVT_STC_URIDROPPED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_URIDROPPED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
364 | #define EVT_STC_DWELLSTART(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DWELLSTART, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
365 | #define EVT_STC_DWELLEND(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DWELLEND, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
a29a241f RD |
366 | #define EVT_STC_START_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_START_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), |
367 | #define EVT_STC_DRAG_OVER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DRAG_OVER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
368 | #define EVT_STC_DO_DROP(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DO_DROP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ), | |
1bc32508 | 369 | #endif |
f97d84a6 RD |
370 | |
371 | //---------------------------------------------------------------------- | |
372 | //---------------------------------------------------------------------- | |
373 | #endif | |
374 | ||
375 |