]> git.saurik.com Git - wxWidgets.git/blame - contrib/src/stc/stc.h.in
some minor fixes to the docs (bugs 13271[56])
[wxWidgets.git] / contrib / 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>
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
43class ScintillaWX; // forward declare
44class WordList;
45struct SCNotification;
46
47
48extern const wxChar* wxSTCNameStr;
49
50//----------------------------------------------------------------------
51
52class wxStyledTextCtrl : public wxControl {
53public:
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
148private:
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 OnChar(wxKeyEvent& evt);
158 void OnKeyDown(wxKeyEvent& evt);
159 void OnLoseFocus(wxFocusEvent& evt);
160 void OnGainFocus(wxFocusEvent& evt);
161 void OnSysColourChanged(wxSysColourChangedEvent& evt);
162 void OnEraseBackground(wxEraseEvent& evt);
163 void OnMenu(wxCommandEvent& evt);
164 void OnListBox(wxCommandEvent& evt);
165
166
167 // Turn notifications from Scintilla into events
168 void NotifyChange();
169 void NotifyParent(SCNotification* scn);
170
171 long SendMsg(int msg, long wp=0, long lp=0);
172
173private:
174 DECLARE_EVENT_TABLE()
175 DECLARE_CLASS(wxStyledTextCtrl)
176
177 ScintillaWX* m_swx;
178 wxStopWatch m_stopWatch;
179
180
181 friend class ScintillaWX;
182 friend class Platform;
183#endif
184};
185
186//----------------------------------------------------------------------
187
188class wxStyledTextEvent : public wxCommandEvent {
189public:
190 wxStyledTextEvent(wxEventType commandType=0, int id=0);
191 ~wxStyledTextEvent() {}
192
193 void SetPosition(int pos) { m_position = pos; }
194 void SetKey(int k) { m_key = k; }
195 void SetModifiers(int m) { m_modifiers = m; }
196 void SetModificationType(int t) { m_modificationType = t; }
197 void SetText(const char* t) { m_text = t; }
198 void SetLength(int len) { m_length = len; }
199 void SetLinesAdded(int num) { m_linesAdded = num; }
200 void SetLine(int val) { m_line = val; }
201 void SetFoldLevelNow(int val) { m_foldLevelNow = val; }
202 void SetFoldLevelPrev(int val) { m_foldLevelPrev = val; }
203 void SetMargin(int val) { m_margin = val; }
204 void SetMessage(int val) { m_message = val; }
205 void SetWParam(int val) { m_wParam = val; }
206 void SetLParam(int val) { m_lParam = val; }
207
208 int GetPosition() const { return m_position; }
209 int GetKey() const { return m_key; }
210 int GetModifiers() const { return m_modifiers; }
211 int GetModificationType() const { return m_modificationType; }
212 wxString GetText() const { return m_text; }
213 int GetLength() const { return m_length; }
214 int GetLinesAdded() const { return m_linesAdded; }
215 int GetLine() const { return m_line; }
216 int GetFoldLevelNow() const { return m_foldLevelNow; }
217 int GetFoldLevelPrev() const { return m_foldLevelPrev; }
218 int GetMargin() const { return m_margin; }
219 int GetMessage() const { return m_message; }
220 int GetWParam() const { return m_wParam; }
221 int GetLParam() const { return m_lParam; }
222
223 bool GetShift() const;
224 bool GetControl() const;
225 bool GetAlt() const;
226
227 void CopyObject(wxObject& obj) const;
228
229#ifndef SWIG
230private:
231 DECLARE_DYNAMIC_CLASS(wxStyledTextEvent)
232
233 int m_position;
234 int m_key;
235 int m_modifiers;
236
237 int m_modificationType; // wxEVT_STC_MODIFIED
238 wxString m_text;
239 int m_length;
240 int m_linesAdded;
241 int m_line;
242 int m_foldLevelNow;
243 int m_foldLevelPrev;
244
245 int m_margin; // wxEVT_STC_MARGINCLICK
246
247 int m_message; // wxEVT_STC_MACRORECORD
248 int m_wParam;
249 int m_lParam;
250#endif
251};
252
253
254// Event types
255enum {
256 wxEVT_STC_CHANGE = 1650,
257 wxEVT_STC_STYLENEEDED,
258 wxEVT_STC_CHARADDED,
259 wxEVT_STC_UPDATEUI,
260 wxEVT_STC_SAVEPOINTREACHED,
261 wxEVT_STC_SAVEPOINTLEFT,
262 wxEVT_STC_ROMODIFYATTEMPT,
263 wxEVT_STC_DOUBLECLICK,
264 wxEVT_STC_MODIFIED,
265 wxEVT_STC_KEY,
266 wxEVT_STC_MACRORECORD,
267 wxEVT_STC_MARGINCLICK,
268 wxEVT_STC_NEEDSHOWN,
269 wxEVT_STC_POSCHANGED
270};
271
272
273#ifndef SWIG
274typedef void (wxEvtHandler::*wxStyledTextEventFunction)(wxStyledTextEvent&);
275
276#define EVT_STC_CHANGE(id, fn) { wxEVT_STC_CHANGE, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL },
277#define EVT_STC_STYLENEEDED(id, fn) { wxEVT_STC_STYLENEEDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL },
278#define EVT_STC_CHARADDED(id, fn) { wxEVT_STC_CHARADDED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL },
279#define EVT_STC_UPDATEUI(id, fn) { wxEVT_STC_UPDATEUI, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL },
280#define EVT_STC_SAVEPOINTREACHED(id, fn) { wxEVT_STC_SAVEPOINTREACHED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL },
281#define EVT_STC_SAVEPOINTLEFT(id, fn) { wxEVT_STC_SAVEPOINTLEFT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL },
282#define EVT_STC_ROMODIFYATTEMPT(id, fn) { wxEVT_STC_ROMODIFYATTEMPT, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL },
283#define EVT_STC_DOUBLECLICK(id, fn) { wxEVT_STC_DOUBLECLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL },
284#define EVT_STC_MODIFIED(id, fn) { wxEVT_STC_MODIFIED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL },
285#define EVT_STC_KEY(id, fn) { wxEVT_STC_KEY, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL },
286#define EVT_STC_MACRORECORD(id, fn) { wxEVT_STC_MACRORECORD, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL },
287#define EVT_STC_MARGINCLICK(id, fn) { wxEVT_STC_MARGINCLICK, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL },
288#define EVT_STC_NEEDSHOWN(id, fn) { wxEVT_STC_NEEDSHOWN, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL },
289#define EVT_STC_POSCHANGED(id, fn) { wxEVT_STC_POSCHANGED, id, -1, (wxObjectEventFunction) (wxEventFunction) (wxStyledTextEventFunction) & fn, (wxObject *) NULL },
290
291#endif
292
293//----------------------------------------------------------------------
294//----------------------------------------------------------------------
295#endif
296
297