]> git.saurik.com Git - wxWidgets.git/blob - contrib/src/stc/stc.h.in
Added RCS ID
[wxWidgets.git] / contrib / src / stc / stc.h.in
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>
25 #include <wx/dnd.h>
26
27 #ifndef SWIG
28 /*
29 * If we're using wx in Dynamic Library format do we
30 * want wxStyledTextCtrl to be in DLL form as well?
31 */
32 #if defined(WXUSINGDLL) && \
33 (defined(WXMAKING_STC_DLL) || defined(WXUSING_STC_DLL))
34
35 #if defined(WXMAKING_STC_DLL)
36 // When building the DLL WXSTC_DECLSPEC exports classes
37 # define WXSTC_DECLSPEC WXEXPORT
38 #elif defined(WXUSING_STC_DLL)
39 // When using the DLL WXSTC_DECLSPEC imports classes
40 # define WXSTC_DECLSPEC WXIMPORT
41 #endif // defined(WXBUILD_STC_DLL)
42
43 #else
44 // When building the static library nullify the effect of WXSTC_DECLSPEC
45 #define WXSTC_DECLSPEC
46 #endif // WXUSINGDLL && (WXMAKING_STC_DLL || WXUSING_STC_DLL)
47
48 #endif // SWIG
49
50
51 //----------------------------------------------------------------------
52
53 // Should a wxPopupWindow be used for the call tips and autocomplete windows?
54 #ifndef wxSTC_USE_POPUP
55 #define wxSTC_USE_POPUP 1
56 #endif
57
58 //----------------------------------------------------------------------
59 // BEGIN generated section. The following code is automatically generated
60 // by gen_iface.py. Do not edit this file. Edit stc.h.in instead
61 // and regenerate
62
63 %(VALUES)s
64
65
66 //-----------------------------------------
67 // Commands that can be bound to keystrokes
68 %(CMDS)s
69
70
71 // END of generated section
72 //----------------------------------------------------------------------
73
74 class ScintillaWX; // forward declare
75 class WordList;
76 struct SCNotification;
77
78 #ifndef SWIG
79 extern WXSTC_DECLSPEC const wxChar* wxSTCNameStr;
80 class WXSTC_DECLSPEC wxStyledTextCtrl;
81 class WXSTC_DECLSPEC wxStyledTextEvent;
82 #endif
83
84 //----------------------------------------------------------------------
85
86 class wxStyledTextCtrl : public wxControl {
87 public:
88
89 #ifdef SWIG
90 wxStyledTextCtrl(wxWindow *parent, wxWindowID id,
91 const wxPoint& pos = wxDefaultPosition,
92 const wxSize& size = wxDefaultSize, long style = 0,
93 const wxString& name = wxPySTCNameStr);
94 %%pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
95
96 #else
97 wxStyledTextCtrl(wxWindow *parent, wxWindowID id,
98 const wxPoint& pos = wxDefaultPosition,
99 const wxSize& size = wxDefaultSize, long style = 0,
100 const wxString& name = wxSTCNameStr);
101 #endif
102
103
104 #ifndef SWIG
105 ~wxStyledTextCtrl();
106 #endif
107
108 //----------------------------------------------------------------------
109 // BEGIN generated section. The following code is automatically generated
110 // by gen_iface.py. Do not edit this file. Edit stc.h.in instead
111 // and regenerate
112
113 %(METHOD_DEFS)s
114
115 // END of generated section
116 //----------------------------------------------------------------------
117 // Others...
118
119
120 // Returns the line number of the line with the caret.
121 int GetCurrentLine();
122
123 // Extract style settings from a spec-string which is composed of one or
124 // more of the following comma separated elements:
125 //
126 // bold turns on bold
127 // italic turns on italics
128 // fore:#RRGGBB sets the foreground colour
129 // back:#RRGGBB sets the background colour
130 // face:[facename] sets the font face name to use
131 // size:[num] sets the font size in points
132 // eol turns on eol filling
133 // underline turns on underlining
134 //
135 void StyleSetSpec(int styleNum, const wxString& spec);
136
137
138
139 // Set style size, face, bold, italic, and underline attributes from
140 // a wxFont's attributes.
141 void StyleSetFont(int styleNum, wxFont& font);
142
143
144
145 // Set all font style attributes at once.
146 void StyleSetFontAttr(int styleNum, int size,
147 const wxString& faceName,
148 bool bold, bool italic,
149 bool underline);
150
151
152
153 // Perform one of the operations defined by the wxSTC_CMD_* constants.
154 void CmdKeyExecute(int cmd);
155
156
157
158 // Set the left and right margin in the edit area, measured in pixels.
159 void SetMargins(int left, int right);
160
161
162 // Retrieve the start and end positions of the current selection.
163 #ifdef SWIG
164 void GetSelection(int* OUTPUT, int* OUTPUT);
165 #else
166 void GetSelection(int* startPos, int* endPos);
167 #endif
168
169 // Retrieve the point in the window where a position is displayed.
170 wxPoint PointFromPosition(int pos);
171
172
173 // Scroll enough to make the given line visible
174 void ScrollToLine(int line);
175
176
177 // Scroll enough to make the given column visible
178 void ScrollToColumn(int column);
179
180
181 // Send a message to Scintilla
182 long SendMsg(int msg, long wp=0, long lp=0);
183
184
185 // Set the vertical scrollbar to use instead of the ont that's built-in.
186 void SetVScrollBar(wxScrollBar* bar) { m_vScrollBar = bar; }
187
188
189 // Set the horizontal scrollbar to use instead of the ont that's built-in.
190 void SetHScrollBar(wxScrollBar* bar) { m_hScrollBar = bar; }
191
192 // Can be used to prevent the EVT_CHAR handler from adding the char
193 bool GetLastKeydownProcessed() { return m_lastKeyDownConsumed; }
194 void SetLastKeydownProcessed(bool val) { m_lastKeyDownConsumed = val; }
195
196
197 //----------------------------------------------------------------------
198
199
200 #ifndef SWIG
201 private:
202 // Event handlers
203 void OnPaint(wxPaintEvent& evt);
204 void OnScrollWin(wxScrollWinEvent& evt);
205 void OnScroll(wxScrollEvent& evt);
206 void OnSize(wxSizeEvent& evt);
207 void OnMouseLeftDown(wxMouseEvent& evt);
208 void OnMouseMove(wxMouseEvent& evt);
209 void OnMouseLeftUp(wxMouseEvent& evt);
210 void OnMouseRightUp(wxMouseEvent& evt);
211 void OnMouseMiddleUp(wxMouseEvent& evt);
212 void OnContextMenu(wxContextMenuEvent& evt);
213 void OnMouseWheel(wxMouseEvent& evt);
214 void OnChar(wxKeyEvent& evt);
215 void OnKeyDown(wxKeyEvent& evt);
216 void OnLoseFocus(wxFocusEvent& evt);
217 void OnGainFocus(wxFocusEvent& evt);
218 void OnSysColourChanged(wxSysColourChangedEvent& evt);
219 void OnEraseBackground(wxEraseEvent& evt);
220 void OnMenu(wxCommandEvent& evt);
221 void OnListBox(wxCommandEvent& evt);
222
223
224 // Turn notifications from Scintilla into events
225 void NotifyChange();
226 void NotifyParent(SCNotification* scn);
227
228
229 private:
230 DECLARE_EVENT_TABLE()
231 DECLARE_CLASS(wxStyledTextCtrl)
232
233 ScintillaWX* m_swx;
234 wxStopWatch m_stopWatch;
235 wxScrollBar* m_vScrollBar;
236 wxScrollBar* m_hScrollBar;
237
238 bool m_lastKeyDownConsumed;
239
240 friend class ScintillaWX;
241 friend class Platform;
242 #endif
243 };
244
245 //----------------------------------------------------------------------
246
247 // SWIG can't handle "#if" type of conditionals, only "#ifdef"
248 #ifdef SWIG
249 #define STC_USE_DND 1
250 #else
251 #if wxUSE_DRAG_AND_DROP
252 #define STC_USE_DND 1
253 #endif
254 #endif
255
256 class wxStyledTextEvent : public wxCommandEvent {
257 public:
258 wxStyledTextEvent(wxEventType commandType=0, int id=0);
259 #ifndef SWIG
260 wxStyledTextEvent(const wxStyledTextEvent& event);
261 #endif
262 ~wxStyledTextEvent() {}
263
264 void SetPosition(int pos) { m_position = pos; }
265 void SetKey(int k) { m_key = k; }
266 void SetModifiers(int m) { m_modifiers = m; }
267 void SetModificationType(int t) { m_modificationType = t; }
268 void SetText(const wxString& t) { m_text = t; }
269 void SetLength(int len) { m_length = len; }
270 void SetLinesAdded(int num) { m_linesAdded = num; }
271 void SetLine(int val) { m_line = val; }
272 void SetFoldLevelNow(int val) { m_foldLevelNow = val; }
273 void SetFoldLevelPrev(int val) { m_foldLevelPrev = val; }
274 void SetMargin(int val) { m_margin = val; }
275 void SetMessage(int val) { m_message = val; }
276 void SetWParam(int val) { m_wParam = val; }
277 void SetLParam(int val) { m_lParam = val; }
278 void SetListType(int val) { m_listType = val; }
279 void SetX(int val) { m_x = val; }
280 void SetY(int val) { m_y = val; }
281 void SetDragText(const wxString& val) { m_dragText = val; }
282 void SetDragAllowMove(bool val) { m_dragAllowMove = val; }
283 #ifdef STC_USE_DND
284 void SetDragResult(wxDragResult val) { m_dragResult = val; }
285 #endif
286
287 int GetPosition() const { return m_position; }
288 int GetKey() const { return m_key; }
289 int GetModifiers() const { return m_modifiers; }
290 int GetModificationType() const { return m_modificationType; }
291 wxString GetText() const { return m_text; }
292 int GetLength() const { return m_length; }
293 int GetLinesAdded() const { return m_linesAdded; }
294 int GetLine() const { return m_line; }
295 int GetFoldLevelNow() const { return m_foldLevelNow; }
296 int GetFoldLevelPrev() const { return m_foldLevelPrev; }
297 int GetMargin() const { return m_margin; }
298 int GetMessage() const { return m_message; }
299 int GetWParam() const { return m_wParam; }
300 int GetLParam() const { return m_lParam; }
301 int GetListType() const { return m_listType; }
302 int GetX() const { return m_x; }
303 int GetY() const { return m_y; }
304 wxString GetDragText() { return m_dragText; }
305 bool GetDragAllowMove() { return m_dragAllowMove; }
306 #ifdef STC_USE_DND
307 wxDragResult GetDragResult() { return m_dragResult; }
308 #endif
309
310 bool GetShift() const;
311 bool GetControl() const;
312 bool GetAlt() const;
313
314 virtual wxEvent* Clone() const { return new wxStyledTextEvent(*this); }
315
316 #ifndef SWIG
317 private:
318 DECLARE_DYNAMIC_CLASS(wxStyledTextEvent)
319
320 int m_position;
321 int m_key;
322 int m_modifiers;
323
324 int m_modificationType; // wxEVT_STC_MODIFIED
325 wxString m_text;
326 int m_length;
327 int m_linesAdded;
328 int m_line;
329 int m_foldLevelNow;
330 int m_foldLevelPrev;
331
332 int m_margin; // wxEVT_STC_MARGINCLICK
333
334 int m_message; // wxEVT_STC_MACRORECORD
335 int m_wParam;
336 int m_lParam;
337
338 int m_listType;
339 int m_x;
340 int m_y;
341
342 wxString m_dragText; // wxEVT_STC_START_DRAG, wxEVT_STC_DO_DROP
343 bool m_dragAllowMove; // wxEVT_STC_START_DRAG
344
345 #if wxUSE_DRAG_AND_DROP
346 wxDragResult m_dragResult; // wxEVT_STC_DRAG_OVER,wxEVT_STC_DO_DROP
347 #endif
348 #endif
349 };
350
351 #ifndef SWIG
352 BEGIN_DECLARE_EVENT_TYPES()
353 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_CHANGE, 1650)
354 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_STYLENEEDED, 1651)
355 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_CHARADDED, 1652)
356 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_SAVEPOINTREACHED, 1653)
357 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_SAVEPOINTLEFT, 1654)
358 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_ROMODIFYATTEMPT, 1655)
359 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_KEY, 1656)
360 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_DOUBLECLICK, 1657)
361 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_UPDATEUI, 1658)
362 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_MODIFIED, 1659)
363 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_MACRORECORD, 1660)
364 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_MARGINCLICK, 1661)
365 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_NEEDSHOWN, 1662)
366 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_POSCHANGED, 1663)
367 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_PAINTED, 1664)
368 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_USERLISTSELECTION, 1665)
369 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_URIDROPPED, 1666)
370 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_DWELLSTART, 1667)
371 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_DWELLEND, 1668)
372 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_START_DRAG, 1669)
373 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_DRAG_OVER, 1670)
374 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_DO_DROP, 1671)
375 DECLARE_LOCAL_EVENT_TYPE(wxEVT_STC_ZOOM, 1672)
376 END_DECLARE_EVENT_TYPES()
377 #else
378 enum {
379 wxEVT_STC_CHANGE,
380 wxEVT_STC_STYLENEEDED,
381 wxEVT_STC_CHARADDED,
382 wxEVT_STC_SAVEPOINTREACHED,
383 wxEVT_STC_SAVEPOINTLEFT,
384 wxEVT_STC_ROMODIFYATTEMPT,
385 wxEVT_STC_KEY,
386 wxEVT_STC_DOUBLECLICK,
387 wxEVT_STC_UPDATEUI,
388 wxEVT_STC_MODIFIED,
389 wxEVT_STC_MACRORECORD,
390 wxEVT_STC_MARGINCLICK,
391 wxEVT_STC_NEEDSHOWN,
392 wxEVT_STC_POSCHANGED,
393 wxEVT_STC_PAINTED,
394 wxEVT_STC_USERLISTSELECTION,
395 wxEVT_STC_URIDROPPED,
396 wxEVT_STC_DWELLSTART,
397 wxEVT_STC_DWELLEND,
398 wxEVT_STC_START_DRAG,
399 wxEVT_STC_DRAG_OVER,
400 wxEVT_STC_DO_DROP,
401 wxEVT_STC_ZOOM,
402 };
403 #endif
404
405
406
407 #ifndef SWIG
408 typedef void (wxEvtHandler::*wxStyledTextEventFunction)(wxStyledTextEvent&);
409
410 #define EVT_STC_CHANGE(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_CHANGE, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
411 #define EVT_STC_STYLENEEDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_STYLENEEDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
412 #define EVT_STC_CHARADDED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_CHARADDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
413 #define EVT_STC_SAVEPOINTREACHED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_SAVEPOINTREACHED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
414 #define EVT_STC_SAVEPOINTLEFT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_SAVEPOINTLEFT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
415 #define EVT_STC_ROMODIFYATTEMPT(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_ROMODIFYATTEMPT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
416 #define EVT_STC_KEY(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_KEY, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
417 #define EVT_STC_DOUBLECLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DOUBLECLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
418 #define EVT_STC_UPDATEUI(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_UPDATEUI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
419 #define EVT_STC_MODIFIED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_MODIFIED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
420 #define EVT_STC_MACRORECORD(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_MACRORECORD, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
421 #define EVT_STC_MARGINCLICK(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_MARGINCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
422 #define EVT_STC_NEEDSHOWN(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_NEEDSHOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
423 #define EVT_STC_POSCHANGED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_POSCHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
424 #define EVT_STC_PAINTED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_PAINTED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
425 #define EVT_STC_USERLISTSELECTION(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_USERLISTSELECTION, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
426 #define EVT_STC_URIDROPPED(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_URIDROPPED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
427 #define EVT_STC_DWELLSTART(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DWELLSTART, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
428 #define EVT_STC_DWELLEND(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DWELLEND, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
429 #define EVT_STC_START_DRAG(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_START_DRAG, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
430 #define EVT_STC_DRAG_OVER(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DRAG_OVER, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
431 #define EVT_STC_DO_DROP(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_DO_DROP, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
432 #define EVT_STC_ZOOM(id, fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_STC_ZOOM, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL ),
433 #endif
434
435 //----------------------------------------------------------------------
436 // Utility functions used within wxSTC
437
438 #ifndef SWIG
439
440 inline wxString stc2wx(const char* str) {
441 #if wxUSE_UNICODE
442 return wxString(str, wxConvUTF8);
443 #else
444 return wxString(str);
445 #endif
446 }
447
448 inline wxString stc2wx(const char* str, size_t len) {
449 #if wxUSE_UNICODE
450 return wxString(str, wxConvUTF8, len);
451 #else
452 return wxString(str, len);
453 #endif
454 }
455
456 #if wxUSE_UNICODE
457 inline const wxWX2MBbuf wx2stc(const wxString& str) {
458 return str.mb_str(wxConvUTF8);
459 }
460 #else
461 inline const wxWX2MBbuf wx2stc(const wxString& str) {
462 return str.mbc_str();
463 }
464 #endif
465
466 #endif
467
468
469 //----------------------------------------------------------------------
470 #endif
471
472