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