Fixup clipboard usage a bit more.
[wxWidgets.git] / src / stc / ScintillaWX.cpp
1 ////////////////////////////////////////////////////////////////////////////
2 // Name: ScintillaWX.cxx
3 // Purpose: A wxWindows implementation of Scintilla. A class derived
4 // from ScintillaBase that uses the "wx platform" defined in
5 // PlatformWX.cxx This class is one end of a bridge between
6 // the wx world and the Scintilla world. It needs a peer
7 // object of type wxStyledTextCtrl to function.
8 //
9 // Author: Robin Dunn
10 //
11 // Created: 13-Jan-2000
12 // RCS-ID: $Id$
13 // Copyright: (c) 2000 by Total Control Software
14 // Licence: wxWindows license
15 /////////////////////////////////////////////////////////////////////////////
16
17
18 #include "ScintillaWX.h"
19 #include "wx/stc/stc.h"
20 #include "PlatWX.h"
21
22
23 //----------------------------------------------------------------------
24
25 const int H_SCROLL_MAX = 4000;
26 const int H_SCROLL_STEP = 20;
27 const int H_SCROLL_PAGE = 200;
28
29 //----------------------------------------------------------------------
30 // Helper classes
31
32 class wxSTCTimer : public wxTimer {
33 public:
34 wxSTCTimer(ScintillaWX* swx) {
35 this->swx = swx;
36 }
37
38 void Notify() {
39 swx->DoTick();
40 }
41
42 private:
43 ScintillaWX* swx;
44 };
45
46
47 #if wxUSE_DRAG_AND_DROP
48 bool wxSTCDropTarget::OnDropText(wxCoord x, wxCoord y, const wxString& data) {
49 return swx->DoDropText(x, y, data);
50 }
51
52 wxDragResult wxSTCDropTarget::OnEnter(wxCoord x, wxCoord y, wxDragResult def) {
53 return swx->DoDragEnter(x, y, def);
54 }
55
56 wxDragResult wxSTCDropTarget::OnDragOver(wxCoord x, wxCoord y, wxDragResult def) {
57 return swx->DoDragOver(x, y, def);
58 }
59
60 void wxSTCDropTarget::OnLeave() {
61 swx->DoDragLeave();
62 }
63 #endif
64
65
66 #if wxUSE_POPUPWIN && wxSTC_USE_POPUP
67 #include <wx/popupwin.h>
68 #define wxSTCCallTipBase wxPopupWindow
69 #define param2 wxBORDER_NONE // popup's 2nd param is flags
70 #else
71 #define wxSTCCallTipBase wxWindow
72 #define param2 -1 // wxWindows 2nd param is ID
73 #endif
74
75 class wxSTCCallTip : public wxSTCCallTipBase {
76 public:
77 wxSTCCallTip(wxWindow* parent, CallTip* ct)
78 : wxSTCCallTipBase(parent, param2)
79 {
80 m_ct = ct;
81 }
82
83 ~wxSTCCallTip() {
84 if (HasCapture()) ReleaseMouse();
85 }
86
87 void OnPaint(wxPaintEvent& evt) {
88 wxPaintDC dc(this);
89 Surface* surfaceWindow = Surface::Allocate();
90 surfaceWindow->Init(&dc);
91 m_ct->PaintCT(surfaceWindow);
92 delete surfaceWindow;
93 }
94
95 void OnFocus(wxFocusEvent& event) {
96 GetParent()->SetFocus();
97 event.Skip();
98 }
99
100 #if wxUSE_POPUPWIN && wxSTC_USE_POPUP
101 virtual void DoSetSize(int x, int y,
102 int width, int height,
103 int sizeFlags = wxSIZE_AUTO) {
104 if (x != -1)
105 GetParent()->ClientToScreen(&x, NULL);
106 if (y != -1)
107 GetParent()->ClientToScreen(NULL, &y);
108 wxSTCCallTipBase::DoSetSize(x, y, width, height, sizeFlags);
109 }
110
111 virtual bool Show( bool show = TRUE ) {
112 bool retval = wxSTCCallTipBase::Show(show);
113 if (show)
114 CaptureMouse();
115 else
116 if (HasCapture()) ReleaseMouse();
117 return retval;
118 }
119
120 void OnLeftDown(wxMouseEvent& ) {
121 Show(FALSE);
122 }
123 #endif
124
125 private:
126 CallTip* m_ct;
127 DECLARE_EVENT_TABLE()
128 };
129
130 BEGIN_EVENT_TABLE(wxSTCCallTip, wxSTCCallTipBase)
131 EVT_PAINT(wxSTCCallTip::OnPaint)
132 EVT_SET_FOCUS(wxSTCCallTip::OnFocus)
133 #if wxUSE_POPUPWIN && wxSTC_USE_POPUP
134 EVT_LEFT_DOWN(wxSTCCallTip::OnLeftDown)
135 #endif
136 END_EVENT_TABLE()
137
138
139 //----------------------------------------------------------------------
140 // Constructor/Destructor
141
142
143 ScintillaWX::ScintillaWX(wxStyledTextCtrl* win) {
144 capturedMouse = false;
145 wMain = win;
146 stc = win;
147 wheelRotation = 0;
148 Initialise();
149 }
150
151
152 ScintillaWX::~ScintillaWX() {
153 SetTicking(false);
154 }
155
156 //----------------------------------------------------------------------
157 // base class virtuals
158
159
160 void ScintillaWX::Initialise() {
161 //ScintillaBase::Initialise();
162 #if wxUSE_DRAG_AND_DROP
163 dropTarget = new wxSTCDropTarget;
164 dropTarget->SetScintilla(this);
165 stc->SetDropTarget(dropTarget);
166 #endif
167 }
168
169
170 void ScintillaWX::Finalise() {
171 ScintillaBase::Finalise();
172 }
173
174
175 void ScintillaWX::StartDrag() {
176 #if wxUSE_DRAG_AND_DROP
177 wxString dragText = stc2wx(drag.s, drag.len);
178
179 // Send an event to allow the drag text to be changed
180 wxStyledTextEvent evt(wxEVT_STC_START_DRAG, stc->GetId());
181 evt.SetEventObject(stc);
182 evt.SetDragText(dragText);
183 evt.SetDragAllowMove(TRUE);
184 evt.SetPosition(wxMin(stc->GetSelectionStart(),
185 stc->GetSelectionEnd()));
186 stc->GetEventHandler()->ProcessEvent(evt);
187 dragText = evt.GetDragText();
188
189 if (dragText.Length()) {
190 wxDropSource source(stc);
191 wxTextDataObject data(dragText);
192 wxDragResult result;
193
194 source.SetData(data);
195 dropWentOutside = TRUE;
196 result = source.DoDragDrop(evt.GetDragAllowMove());
197 if (result == wxDragMove && dropWentOutside)
198 ClearSelection();
199 inDragDrop = FALSE;
200 SetDragPosition(invalidPosition);
201 }
202 #endif
203 }
204
205
206 void ScintillaWX::SetTicking(bool on) {
207 wxSTCTimer* steTimer;
208 if (timer.ticking != on) {
209 timer.ticking = on;
210 if (timer.ticking) {
211 steTimer = new wxSTCTimer(this);
212 steTimer->Start(timer.tickSize);
213 timer.tickerID = steTimer;
214 } else {
215 steTimer = (wxSTCTimer*)timer.tickerID;
216 steTimer->Stop();
217 delete steTimer;
218 timer.tickerID = 0;
219 }
220 }
221 timer.ticksToWait = caret.period;
222 }
223
224
225 void ScintillaWX::SetMouseCapture(bool on) {
226 if (on && !capturedMouse)
227 stc->CaptureMouse();
228 else if (!on && capturedMouse)
229 stc->ReleaseMouse();
230 capturedMouse = on;
231 }
232
233
234 bool ScintillaWX::HaveMouseCapture() {
235 return capturedMouse;
236 }
237
238
239 void ScintillaWX::ScrollText(int linesToMove) {
240 int dy = vs.lineHeight * (linesToMove);
241 stc->ScrollWindow(0, dy);
242 stc->Update();
243 }
244
245 void ScintillaWX::SetVerticalScrollPos() {
246 if (stc->m_vScrollBar == NULL) { // Use built-in scrollbar
247 stc->SetScrollPos(wxVERTICAL, topLine);
248 }
249 else { // otherwise use the one that's been given to us
250 stc->m_vScrollBar->SetThumbPosition(topLine);
251 }
252 }
253
254 void ScintillaWX::SetHorizontalScrollPos() {
255 if (stc->m_hScrollBar == NULL) { // Use built-in scrollbar
256 stc->SetScrollPos(wxHORIZONTAL, xOffset);
257 }
258 else { // otherwise use the one that's been given to us
259 stc->m_hScrollBar->SetThumbPosition(xOffset);
260 }
261 }
262
263
264 bool ScintillaWX::ModifyScrollBars(int nMax, int nPage) {
265 bool modified = false;
266
267 if (stc->m_vScrollBar == NULL) { // Use built-in scrollbar
268 int sbMax = stc->GetScrollRange(wxVERTICAL);
269 int sbThumb = stc->GetScrollThumb(wxVERTICAL);
270 int sbPos = stc->GetScrollPos(wxVERTICAL);
271 if (sbMax != nMax || sbThumb != nPage) {
272 stc->SetScrollbar(wxVERTICAL, sbPos, nPage, nMax);
273 modified = true;
274 }
275 }
276 else { // otherwise use the one that's been given to us
277 int sbMax = stc->m_vScrollBar->GetRange();
278 int sbPage = stc->m_vScrollBar->GetPageSize();
279 int sbPos = stc->m_vScrollBar->GetThumbPosition();
280 if (sbMax != nMax || sbPage != nPage) {
281 stc->m_vScrollBar->SetScrollbar(sbPos, nPage, nMax, nPage);
282 modified = true;
283 }
284 }
285
286
287 if (horizontalScrollBarVisible) {
288 if (stc->m_hScrollBar == NULL) { // Use built-in scrollbar
289 int sbMax = stc->GetScrollRange(wxHORIZONTAL);
290 int sbThumb = stc->GetScrollThumb(wxHORIZONTAL);
291 if ((sbMax != H_SCROLL_MAX) || (sbThumb != H_SCROLL_STEP)) {
292 stc->SetScrollbar(wxHORIZONTAL, 0, H_SCROLL_STEP, H_SCROLL_MAX);
293 modified = true;
294 }
295 }
296 else { // otherwise use the one that's been given to us
297 int sbMax = stc->m_hScrollBar->GetRange();
298 int sbPage = stc->m_hScrollBar->GetPageSize();
299 if ((sbMax != H_SCROLL_MAX) || (sbPage != H_SCROLL_STEP)) {
300 stc->m_hScrollBar->SetScrollbar(0, H_SCROLL_STEP, H_SCROLL_MAX, H_SCROLL_STEP);
301 modified = true;
302 }
303 }
304 }
305 return modified;
306 }
307
308
309 void ScintillaWX::NotifyChange() {
310 stc->NotifyChange();
311 }
312
313
314 void ScintillaWX::NotifyParent(SCNotification scn) {
315 stc->NotifyParent(&scn);
316 }
317
318
319
320 void ScintillaWX::Copy() {
321 if (currentPos != anchor) {
322 SelectionText st;
323 CopySelectionRange(&st);
324 if (wxTheClipboard->Open()) {
325 wxTheClipboard->UsePrimarySelection();
326 wxString text = stc2wx(st.s, st.len);
327 wxTheClipboard->SetData(new wxTextDataObject(text));
328 wxTheClipboard->Close();
329 }
330 }
331 }
332
333
334 void ScintillaWX::Paste() {
335 pdoc->BeginUndoAction();
336 ClearSelection();
337
338 wxTextDataObject data;
339 bool gotData = FALSE;
340
341 if (wxTheClipboard->Open()) {
342 wxTheClipboard->UsePrimarySelection();
343 gotData = wxTheClipboard->GetData(data);
344 wxTheClipboard->Close();
345 }
346 if (gotData) {
347 wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(data.GetText());
348 int len = strlen(buf);
349 pdoc->InsertString(currentPos, buf, len);
350 SetEmptySelection(currentPos + len);
351 }
352
353 pdoc->EndUndoAction();
354 NotifyChange();
355 Redraw();
356 }
357
358
359 bool ScintillaWX::CanPaste() {
360 bool canPaste = FALSE;
361 bool didOpen;
362
363 if ( (didOpen = !wxTheClipboard->IsOpened()) )
364 wxTheClipboard->Open();
365
366 if (wxTheClipboard->IsOpened()) {
367 wxTheClipboard->UsePrimarySelection();
368 canPaste = wxTheClipboard->IsSupported(wxUSE_UNICODE ? wxDF_UNICODETEXT : wxDF_TEXT);
369 if (didOpen)
370 wxTheClipboard->Close();
371 }
372 return canPaste;
373 }
374
375 void ScintillaWX::CreateCallTipWindow(PRectangle) {
376 ct.wCallTip = new wxSTCCallTip(stc, &ct);
377 ct.wDraw = ct.wCallTip;
378 }
379
380
381 void ScintillaWX::AddToPopUp(const char *label, int cmd, bool enabled) {
382 if (!label[0])
383 ((wxMenu*)popup.GetID())->AppendSeparator();
384 else
385 ((wxMenu*)popup.GetID())->Append(cmd, stc2wx(label));
386
387 if (!enabled)
388 ((wxMenu*)popup.GetID())->Enable(cmd, enabled);
389 }
390
391
392 void ScintillaWX::ClaimSelection() {
393
394 }
395
396
397 long ScintillaWX::DefWndProc(unsigned int /*iMessage*/, unsigned long /*wParam*/, long /*lParam*/) {
398 return 0;
399 }
400
401 long ScintillaWX::WndProc(unsigned int iMessage, unsigned long wParam, long lParam) {
402 // switch (iMessage) {
403 // case EM_CANPASTE:
404 // return CanPaste();
405 // default:
406 return ScintillaBase::WndProc(iMessage, wParam, lParam);
407 // }
408 // return 0;
409 }
410
411
412
413 //----------------------------------------------------------------------
414 // Event delegates
415
416 void ScintillaWX::DoPaint(wxDC* dc, wxRect rect) {
417
418 paintState = painting;
419 Surface* surfaceWindow = Surface::Allocate();
420 surfaceWindow->Init(dc);
421 PRectangle rcPaint = PRectangleFromwxRect(rect);
422 dc->BeginDrawing();
423 Paint(surfaceWindow, rcPaint);
424 dc->EndDrawing();
425 delete surfaceWindow;
426 if (paintState == paintAbandoned) {
427 // Painting area was insufficient to cover new styling or brace highlight positions
428 FullPaint();
429 }
430 paintState = notPainting;
431 #ifdef __WXGTK__
432 // On wxGTK the editor window paints can overwrite the listbox...
433 if (ac.Active())
434 ((wxWindow*)ac.lb.GetID())->Refresh(TRUE);
435 #endif
436 }
437
438
439 void ScintillaWX::DoHScroll(int type, int pos) {
440 int xPos = xOffset;
441 if (type == wxEVT_SCROLLWIN_LINEUP || type == wxEVT_SCROLL_LINEUP)
442 xPos -= H_SCROLL_STEP;
443 else if (type == wxEVT_SCROLLWIN_LINEDOWN || type == wxEVT_SCROLL_LINEDOWN)
444 xPos += H_SCROLL_STEP;
445 else if (type == wxEVT_SCROLLWIN_PAGEUP || type == wxEVT_SCROLL_PAGEUP)
446 xPos -= H_SCROLL_PAGE;
447 else if (type == wxEVT_SCROLLWIN_PAGEDOWN || type == wxEVT_SCROLL_PAGEDOWN)
448 xPos += H_SCROLL_PAGE;
449 else if (type == wxEVT_SCROLLWIN_TOP || type == wxEVT_SCROLL_TOP)
450 xPos = 0;
451 else if (type == wxEVT_SCROLLWIN_BOTTOM || type == wxEVT_SCROLL_BOTTOM)
452 xPos = H_SCROLL_MAX;
453 else if (type == wxEVT_SCROLLWIN_THUMBTRACK || type == wxEVT_SCROLL_THUMBTRACK)
454 xPos = pos;
455
456 HorizontalScrollTo(xPos);
457 }
458
459 void ScintillaWX::DoVScroll(int type, int pos) {
460 int topLineNew = topLine;
461 if (type == wxEVT_SCROLLWIN_LINEUP || type == wxEVT_SCROLL_LINEUP)
462 topLineNew -= 1;
463 else if (type == wxEVT_SCROLLWIN_LINEDOWN || type == wxEVT_SCROLL_LINEDOWN)
464 topLineNew += 1;
465 else if (type == wxEVT_SCROLLWIN_PAGEUP || type == wxEVT_SCROLL_PAGEUP)
466 topLineNew -= LinesToScroll();
467 else if (type == wxEVT_SCROLLWIN_PAGEDOWN || type == wxEVT_SCROLL_PAGEDOWN)
468 topLineNew += LinesToScroll();
469 else if (type == wxEVT_SCROLLWIN_TOP || type == wxEVT_SCROLL_TOP)
470 topLineNew = 0;
471 else if (type == wxEVT_SCROLLWIN_BOTTOM || type == wxEVT_SCROLL_BOTTOM)
472 topLineNew = MaxScrollPos();
473 else if (type == wxEVT_SCROLLWIN_THUMBTRACK || type == wxEVT_SCROLL_THUMBTRACK)
474 topLineNew = pos;
475
476 ScrollTo(topLineNew);
477 }
478
479 void ScintillaWX::DoMouseWheel(int rotation, int delta,
480 int linesPerAction, int ctrlDown,
481 bool isPageScroll ) {
482 int topLineNew = topLine;
483 int lines;
484
485 if (ctrlDown) { // Zoom the fonts if Ctrl key down
486 if (rotation < 0) {
487 KeyCommand(SCI_ZOOMIN);
488 }
489 else {
490 KeyCommand(SCI_ZOOMOUT);
491 }
492 }
493 else { // otherwise just scroll the window
494 wheelRotation += rotation;
495 lines = wheelRotation / delta;
496 wheelRotation -= lines * delta;
497 if (lines != 0) {
498 if (isPageScroll)
499 lines = lines * LinesOnScreen(); // lines is either +1 or -1
500 else
501 lines *= linesPerAction;
502 topLineNew -= lines;
503 ScrollTo(topLineNew);
504 }
505 }
506 }
507
508
509 void ScintillaWX::DoSize(int width, int height) {
510 // PRectangle rcClient(0,0,width,height);
511 // SetScrollBarsTo(rcClient);
512 // DropGraphics();
513 ChangeSize();
514 }
515
516 void ScintillaWX::DoLoseFocus(){
517 SetFocusState(false);
518 }
519
520 void ScintillaWX::DoGainFocus(){
521 SetFocusState(true);
522 }
523
524 void ScintillaWX::DoSysColourChange() {
525 InvalidateStyleData();
526 }
527
528 void ScintillaWX::DoButtonDown(Point pt, unsigned int curTime, bool shift, bool ctrl, bool alt) {
529 ButtonDown(pt, curTime, shift, ctrl, alt);
530 }
531
532 void ScintillaWX::DoButtonUp(Point pt, unsigned int curTime, bool ctrl) {
533 ButtonUp(pt, curTime, ctrl);
534 }
535
536 void ScintillaWX::DoButtonMove(Point pt) {
537 ButtonMove(pt);
538 }
539
540
541 void ScintillaWX::DoAddChar(int key) {
542 AddChar(key);
543 }
544
545 int ScintillaWX::DoKeyDown(int key, bool shift, bool ctrl, bool alt, bool* consumed) {
546 #if defined(__WXGTK__) || defined(__WXMAC__)
547 // Ctrl chars (A-Z) end up with the wrong keycode on wxGTK...
548 if (ctrl && key >= 1 && key <= 26)
549 key += 'A' - 1;
550 #endif
551
552 switch (key) {
553 case WXK_DOWN: key = SCK_DOWN; break;
554 case WXK_UP: key = SCK_UP; break;
555 case WXK_LEFT: key = SCK_LEFT; break;
556 case WXK_RIGHT: key = SCK_RIGHT; break;
557 case WXK_HOME: key = SCK_HOME; break;
558 case WXK_END: key = SCK_END; break;
559 case WXK_PRIOR: key = SCK_PRIOR; break;
560 case WXK_NEXT: key = SCK_NEXT; break;
561 case WXK_DELETE: key = SCK_DELETE; break;
562 case WXK_INSERT: key = SCK_INSERT; break;
563 case WXK_ESCAPE: key = SCK_ESCAPE; break;
564 case WXK_BACK: key = SCK_BACK; break;
565 case WXK_TAB: key = SCK_TAB; break;
566 case WXK_RETURN: key = SCK_RETURN; break;
567 case WXK_ADD: // fall through
568 case WXK_NUMPAD_ADD: key = SCK_ADD; break;
569 case WXK_SUBTRACT: // fall through
570 case WXK_NUMPAD_SUBTRACT: key = SCK_SUBTRACT; break;
571 case WXK_DIVIDE: // fall through
572 case WXK_NUMPAD_DIVIDE: key = SCK_DIVIDE; break;
573 case WXK_CONTROL: key = 0; break;
574 case WXK_ALT: key = 0; break;
575 case WXK_SHIFT: key = 0; break;
576 case WXK_MENU: key = 0; break;
577 }
578
579 int rv = KeyDown(key, shift, ctrl, alt, consumed);
580
581 if (key)
582 return rv;
583 else
584 return 1;
585 }
586
587
588 void ScintillaWX::DoCommand(int ID) {
589 Command(ID);
590 }
591
592
593 void ScintillaWX::DoContextMenu(Point pt) {
594 if (displayPopupMenu)
595 ContextMenu(pt);
596 }
597
598 void ScintillaWX::DoOnListBox() {
599 AutoCompleteCompleted();
600 }
601
602 //----------------------------------------------------------------------
603
604 #if wxUSE_DRAG_AND_DROP
605 bool ScintillaWX::DoDropText(long x, long y, const wxString& data) {
606 SetDragPosition(invalidPosition);
607
608 // Send an event to allow the drag details to be changed
609 wxStyledTextEvent evt(wxEVT_STC_DO_DROP, stc->GetId());
610 evt.SetEventObject(stc);
611 evt.SetDragResult(dragResult);
612 evt.SetX(x);
613 evt.SetY(y);
614 evt.SetPosition(PositionFromLocation(Point(x,y)));
615 evt.SetDragText(data);
616 stc->GetEventHandler()->ProcessEvent(evt);
617
618 dragResult = evt.GetDragResult();
619 if (dragResult == wxDragMove || dragResult == wxDragCopy) {
620 DropAt(evt.GetPosition(),
621 wx2stc(evt.GetDragText()),
622 dragResult == wxDragMove,
623 FALSE); // TODO: rectangular?
624 return TRUE;
625 }
626 return FALSE;
627 }
628
629
630 wxDragResult ScintillaWX::DoDragEnter(wxCoord x, wxCoord y, wxDragResult def) {
631 dragResult = def;
632 return dragResult;
633 }
634
635
636 wxDragResult ScintillaWX::DoDragOver(wxCoord x, wxCoord y, wxDragResult def) {
637 SetDragPosition(PositionFromLocation(Point(x, y)));
638
639 // Send an event to allow the drag result to be changed
640 wxStyledTextEvent evt(wxEVT_STC_DRAG_OVER, stc->GetId());
641 evt.SetEventObject(stc);
642 evt.SetDragResult(def);
643 evt.SetX(x);
644 evt.SetY(y);
645 evt.SetPosition(PositionFromLocation(Point(x,y)));
646 stc->GetEventHandler()->ProcessEvent(evt);
647
648 dragResult = evt.GetDragResult();
649 return dragResult;
650 }
651
652
653 void ScintillaWX::DoDragLeave() {
654 SetDragPosition(invalidPosition);
655 }
656 #endif
657 //----------------------------------------------------------------------
658
659 // Redraw all of text area. This paint will not be abandoned.
660 void ScintillaWX::FullPaint() {
661 paintState = painting;
662 rcPaint = GetTextRectangle();
663 paintingAllText = true;
664 wxClientDC dc(stc);
665 Surface* surfaceWindow = Surface::Allocate();
666 surfaceWindow->Init(&dc);
667 Paint(surfaceWindow, rcPaint);
668 delete surfaceWindow;
669
670 // stc->Refresh(FALSE);
671
672 paintState = notPainting;
673 }
674
675
676 void ScintillaWX::DoScrollToLine(int line) {
677 ScrollTo(line);
678 }
679
680
681 void ScintillaWX::DoScrollToColumn(int column) {
682 HorizontalScrollTo(column * vs.spaceWidth);
683 }
684
685
686
687 //----------------------------------------------------------------------
688 //----------------------------------------------------------------------