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