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