]> git.saurik.com Git - wxWidgets.git/blob - src/mac/carbon/dnd.cpp
new capture handling, can be turned off
[wxWidgets.git] / src / mac / carbon / dnd.cpp
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: dnd.cpp
3 // Purpose: wxDropTarget, wxDropSource, wxDataObject implementation
4 // Author: Stefan Csomor
5 // Modified by:
6 // Created: 1998-01-01
7 // RCS-ID: $Id$
8 // Copyright: (c) 1998 Stefan Csomor
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
13 #pragma implementation "dnd.h"
14 #endif
15
16 #include "wx/wxprec.h"
17
18 #if wxUSE_DRAG_AND_DROP
19
20 #include "wx/dnd.h"
21 #include "wx/window.h"
22 #include "wx/toplevel.h"
23 #include "wx/app.h"
24 #include "wx/gdicmn.h"
25 #include "wx/mac/private.h"
26
27 #ifndef __DARWIN__
28 #include <Scrap.h>
29 #endif
30
31 // ----------------------------------------------------------------------------
32 // global
33 // ----------------------------------------------------------------------------
34
35 void wxMacEnsureTrackingHandlersInstalled() ;
36
37 typedef struct
38 {
39 wxWindow* m_currentTargetWindow ;
40 wxDropTarget* m_currentTarget ;
41 wxDropSource* m_currentSource ;
42 } MacTrackingGlobals ;
43
44 MacTrackingGlobals gTrackingGlobals ;
45
46 //----------------------------------------------------------------------------
47 // wxDropTarget
48 //----------------------------------------------------------------------------
49
50 wxDropTarget::wxDropTarget( wxDataObject *data )
51 : wxDropTargetBase( data )
52 {
53 wxMacEnsureTrackingHandlersInstalled() ;
54 }
55
56 wxDragResult wxDropTarget::OnDragOver( wxCoord WXUNUSED(x),
57 wxCoord WXUNUSED(y),
58 wxDragResult def )
59 {
60
61 return CurrentDragHasSupportedFormat() ? def : wxDragNone;
62 }
63
64 bool wxDropTarget::OnDrop( wxCoord WXUNUSED(x), wxCoord WXUNUSED(y) )
65 {
66 if (!m_dataObject)
67 return FALSE;
68
69 return CurrentDragHasSupportedFormat() ;
70 }
71
72 wxDragResult wxDropTarget::OnData( wxCoord WXUNUSED(x), wxCoord WXUNUSED(y),
73 wxDragResult def )
74 {
75 if (!m_dataObject)
76 return wxDragNone;
77
78 if (!CurrentDragHasSupportedFormat())
79 return wxDragNone;
80
81 return GetData() ? def : wxDragNone;
82 }
83
84 bool wxDropTarget::CurrentDragHasSupportedFormat()
85 {
86 bool supported = false ;
87 if ( gTrackingGlobals.m_currentSource != NULL )
88 {
89 wxDataObject* data = gTrackingGlobals.m_currentSource->GetDataObject() ;
90
91 if ( data )
92 {
93 size_t formatcount = data->GetFormatCount() ;
94 wxDataFormat *array = new wxDataFormat[ formatcount ];
95 data->GetAllFormats( array );
96 for (size_t i = 0; !supported && i < formatcount ; i++)
97 {
98 wxDataFormat format = array[i] ;
99 if ( m_dataObject->IsSupported( format ) )
100 {
101 supported = true ;
102 break ;
103 }
104 }
105 delete[] array ;
106 }
107 }
108 if ( !supported )
109 {
110 UInt16 items ;
111 OSErr result;
112 CountDragItems((DragReference)m_currentDrag, &items);
113 for (UInt16 index = 1; index <= items && supported == false ; ++index)
114 {
115 ItemReference theItem;
116 FlavorType theType ;
117 UInt16 flavors = 0 ;
118 GetDragItemReferenceNumber((DragReference)m_currentDrag, index, &theItem);
119 CountDragItemFlavors( (DragReference)m_currentDrag, theItem , &flavors ) ;
120 for ( UInt16 flavor = 1 ; flavor <= flavors ; ++flavor )
121 {
122 result = GetFlavorType((DragReference)m_currentDrag, theItem, flavor , &theType);
123 if ( m_dataObject->IsSupportedFormat( wxDataFormat( theType ) ) )
124 {
125 supported = true ;
126 break ;
127 }
128 }
129 }
130 }
131 return supported ;
132 }
133
134 bool wxDropTarget::GetData()
135 {
136 if (!m_dataObject)
137 return FALSE;
138
139 if ( !CurrentDragHasSupportedFormat() )
140 return FALSE ;
141
142 bool transferred = false ;
143 if ( gTrackingGlobals.m_currentSource != NULL )
144 {
145 wxDataObject* data = gTrackingGlobals.m_currentSource->GetDataObject() ;
146
147 if ( data )
148 {
149 size_t formatcount = data->GetFormatCount() ;
150 wxDataFormat *array = new wxDataFormat[ formatcount ];
151 data->GetAllFormats( array );
152 for (size_t i = 0; !transferred && i < formatcount ; i++)
153 {
154 wxDataFormat format = array[i] ;
155 if ( m_dataObject->IsSupported( format ) )
156 {
157 int size = data->GetDataSize( format );
158 transferred = true ;
159
160 if (size == 0)
161 {
162 m_dataObject->SetData(format , 0 , 0 ) ;
163 }
164 else
165 {
166 char *d = new char[size];
167 data->GetDataHere( format , (void*) d );
168 m_dataObject->SetData( format , size , d ) ;
169 delete[] d ;
170 }
171 }
172 }
173 delete[] array ;
174 }
175 }
176 if ( !transferred )
177 {
178 UInt16 items ;
179 OSErr result;
180 bool firstFileAdded = false ;
181 CountDragItems((DragReference)m_currentDrag, &items);
182 for (UInt16 index = 1; index <= items; ++index)
183 {
184 ItemReference theItem;
185 FlavorType theType ;
186 UInt16 flavors = 0 ;
187 GetDragItemReferenceNumber((DragReference)m_currentDrag, index, &theItem);
188 CountDragItemFlavors( (DragReference)m_currentDrag, theItem , &flavors ) ;
189 for ( UInt16 flavor = 1 ; flavor <= flavors ; ++flavor )
190 {
191 result = GetFlavorType((DragReference)m_currentDrag, theItem, flavor , &theType);
192 wxDataFormat format(theType) ;
193 if ( m_dataObject->IsSupportedFormat( format ) )
194 {
195 FlavorFlags theFlags;
196 result = GetFlavorFlags((DragReference)m_currentDrag, theItem, theType, &theFlags);
197 if (result == noErr)
198 {
199 Size dataSize ;
200 Ptr theData ;
201 GetFlavorDataSize((DragReference)m_currentDrag, theItem, theType, &dataSize);
202 if ( theType == kScrapFlavorTypeText )
203 {
204 // this increment is only valid for allocating, on the next GetFlavorData
205 // call it is reset again to the original value
206 dataSize++ ;
207 }
208 else if ( theType == kScrapFlavorTypeUnicode )
209 {
210 // this increment is only valid for allocating, on the next GetFlavorData
211 // call it is reset again to the original value
212 dataSize++ ;
213 dataSize++ ;
214 }
215 theData = new char[dataSize];
216 GetFlavorData((DragReference)m_currentDrag, theItem, theType, (void*) theData, &dataSize, 0L);
217 if( theType == kScrapFlavorTypeText )
218 {
219 theData[dataSize]=0 ;
220 m_dataObject->SetData( wxDataFormat(wxDF_TEXT), dataSize , theData );
221 }
222 #if wxUSE_UNICODE
223 else if ( theType == kScrapFlavorTypeUnicode )
224 {
225 theData[dataSize]=0 ;
226 theData[dataSize+1]=0 ;
227 m_dataObject->SetData( wxDataFormat(wxDF_UNICODETEXT), dataSize , theData );
228 }
229 #endif
230 else if ( theType == kDragFlavorTypeHFS )
231 {
232 HFSFlavor* theFile = (HFSFlavor*) theData ;
233 wxString name = wxMacFSSpec2MacFilename( &theFile->fileSpec ) ;
234 if ( !firstFileAdded )
235 {
236 // reset file list
237 ((wxFileDataObject*)m_dataObject)->SetData( 0 , "" ) ;
238 firstFileAdded = true ;
239 }
240 ((wxFileDataObject*)m_dataObject)->AddFile( name ) ;
241 }
242 else
243 {
244 m_dataObject->SetData( format, dataSize, theData );
245 }
246 delete[] theData;
247 }
248 break ;
249 }
250 }
251 }
252 }
253 return TRUE ;
254 }
255
256 //-------------------------------------------------------------------------
257 // wxDropSource
258 //-------------------------------------------------------------------------
259
260 //-----------------------------------------------------------------------------
261 // drag request
262
263 wxDropSource::wxDropSource(wxWindow *win,
264 const wxCursor &cursorCopy,
265 const wxCursor &cursorMove,
266 const wxCursor &cursorStop)
267 : wxDropSourceBase(cursorCopy, cursorMove, cursorStop)
268 {
269 wxMacEnsureTrackingHandlersInstalled() ;
270 m_window = win;
271 }
272
273 wxDropSource::wxDropSource(wxDataObject& data,
274 wxWindow *win,
275 const wxCursor &cursorCopy,
276 const wxCursor &cursorMove,
277 const wxCursor &cursorStop)
278 : wxDropSourceBase(cursorCopy, cursorMove, cursorStop)
279 {
280 wxMacEnsureTrackingHandlersInstalled() ;
281 SetData( data );
282 m_window = win;
283 }
284
285 wxDropSource::~wxDropSource()
286 {
287 }
288
289
290 wxDragResult wxDropSource::DoDragDrop(int WXUNUSED(flags))
291 {
292 wxASSERT_MSG( m_data, wxT("Drop source: no data") );
293
294 if (!m_data)
295 return (wxDragResult) wxDragNone;
296
297 if (m_data->GetFormatCount() == 0)
298 return (wxDragResult) wxDragNone;
299
300 OSErr result;
301 DragReference theDrag;
302 RgnHandle dragRegion;
303 if ((result = NewDrag(&theDrag)))
304 {
305 return wxDragNone ;
306 }
307 // add data to drag
308 size_t formatCount = m_data->GetFormatCount() ;
309 wxDataFormat *formats = new wxDataFormat[formatCount] ;
310 m_data->GetAllFormats( formats ) ;
311 ItemReference theItem = 1 ;
312 for ( size_t i = 0 ; i < formatCount ; ++i )
313 {
314 size_t dataSize = m_data->GetDataSize( formats[i] ) ;
315 Ptr dataPtr = new char[dataSize] ;
316 m_data->GetDataHere( formats[i] , dataPtr ) ;
317 OSType type = formats[i].GetFormatId() ;
318 if ( type == 'TEXT' )
319 {
320 dataSize-- ;
321 dataPtr[ dataSize ] = 0 ;
322 wxString st( (wxChar*) dataPtr ) ;
323 wxCharBuffer buf = st.mb_str( wxConvLocal) ;
324 AddDragItemFlavor(theDrag, theItem, type , buf.data(), strlen(buf), 0);
325 }
326 else if (type == kDragFlavorTypeHFS )
327 {
328 HFSFlavor theFlavor ;
329 OSErr err = noErr;
330 CInfoPBRec cat;
331
332 wxMacFilename2FSSpec( wxString( dataPtr , *wxConvCurrent ) , &theFlavor.fileSpec ) ;
333
334 cat.hFileInfo.ioNamePtr = theFlavor.fileSpec.name;
335 cat.hFileInfo.ioVRefNum = theFlavor.fileSpec.vRefNum;
336 cat.hFileInfo.ioDirID = theFlavor.fileSpec.parID;
337 cat.hFileInfo.ioFDirIndex = 0;
338 err = PBGetCatInfoSync(&cat);
339 if (err == noErr )
340 {
341 theFlavor.fdFlags = cat.hFileInfo.ioFlFndrInfo.fdFlags;
342 if (theFlavor.fileSpec.parID == fsRtParID) {
343 theFlavor.fileCreator = 'MACS';
344 theFlavor.fileType = 'disk';
345 } else if ((cat.hFileInfo.ioFlAttrib & ioDirMask) != 0) {
346 theFlavor.fileCreator = 'MACS';
347 theFlavor.fileType = 'fold';
348 } else {
349 theFlavor.fileCreator = cat.hFileInfo.ioFlFndrInfo.fdCreator;
350 theFlavor.fileType = cat.hFileInfo.ioFlFndrInfo.fdType;
351 }
352 AddDragItemFlavor(theDrag, theItem, type , &theFlavor, sizeof(theFlavor), 0);
353 }
354 }
355 else
356 {
357 AddDragItemFlavor(theDrag, theItem, type , dataPtr, dataSize, 0);
358 }
359 delete[] dataPtr ;
360 }
361 delete[] formats ;
362
363 dragRegion = NewRgn();
364 RgnHandle tempRgn = NewRgn() ;
365
366 EventRecord* ev = NULL ;
367 #if !TARGET_CARBON // TODO
368 ev = (EventRecord*) wxTheApp->MacGetCurrentEvent() ;
369 #else
370 EventRecord rec ;
371 ev = &rec ;
372 wxMacConvertEventToRecord( (EventRef) wxTheApp->MacGetCurrentEvent() , &rec ) ;
373 #endif
374 const short dragRegionOuterBoundary = 10 ;
375 const short dragRegionInnerBoundary = 9 ;
376
377 SetRectRgn( dragRegion , ev->where.h - dragRegionOuterBoundary ,
378 ev->where.v - dragRegionOuterBoundary ,
379 ev->where.h + dragRegionOuterBoundary ,
380 ev->where.v + dragRegionOuterBoundary ) ;
381
382 SetRectRgn( tempRgn , ev->where.h - dragRegionInnerBoundary ,
383 ev->where.v - dragRegionInnerBoundary ,
384 ev->where.h + dragRegionInnerBoundary ,
385 ev->where.v + dragRegionInnerBoundary ) ;
386
387 DiffRgn( dragRegion , tempRgn , dragRegion ) ;
388 DisposeRgn( tempRgn ) ;
389
390 // TODO:work with promises in order to return data only when drag
391 // was successfully completed
392
393 gTrackingGlobals.m_currentSource = this ;
394 result = TrackDrag(theDrag, ev , dragRegion);
395 DisposeRgn(dragRegion);
396 DisposeDrag(theDrag);
397 gTrackingGlobals.m_currentSource = NULL ;
398
399 bool optionDown = GetCurrentKeyModifiers() & optionKey ;
400 wxDragResult dndresult = optionDown ? wxDragCopy : wxDragMove;
401 return dndresult;
402 }
403
404 bool wxDropSource::MacInstallDefaultCursor(wxDragResult effect)
405 {
406 const wxCursor& cursor = GetCursor(effect);
407 if ( cursor.Ok() )
408 {
409 cursor.MacInstall() ;
410
411 return TRUE;
412 }
413 else
414 {
415 return FALSE;
416 }
417 }
418
419 bool gTrackingGlobalsInstalled = false ;
420
421 // passing the globals via refcon is not needed by the CFM and later architectures anymore
422 // but I'll leave it in there, just in case...
423
424 pascal OSErr wxMacWindowDragTrackingHandler(DragTrackingMessage theMessage, WindowPtr theWindow,
425 void *handlerRefCon, DragReference theDrag) ;
426 pascal OSErr wxMacWindowDragReceiveHandler(WindowPtr theWindow, void *handlerRefCon,
427 DragReference theDrag) ;
428
429 void wxMacEnsureTrackingHandlersInstalled()
430 {
431 if( !gTrackingGlobalsInstalled )
432 {
433 OSErr result;
434
435 result = InstallTrackingHandler(NewDragTrackingHandlerUPP(wxMacWindowDragTrackingHandler), 0L,&gTrackingGlobals);
436 wxASSERT( result == noErr ) ;
437 result = InstallReceiveHandler(NewDragReceiveHandlerUPP(wxMacWindowDragReceiveHandler), 0L, &gTrackingGlobals);
438 wxASSERT( result == noErr ) ;
439
440 gTrackingGlobalsInstalled = true ;
441 }
442 }
443
444 pascal OSErr wxMacWindowDragTrackingHandler(DragTrackingMessage theMessage, WindowPtr theWindow,
445 void *handlerRefCon, DragReference theDrag)
446 {
447 MacTrackingGlobals* trackingGlobals = (MacTrackingGlobals*) handlerRefCon;
448 Point mouse, localMouse;
449 DragAttributes attributes;
450 GetDragAttributes(theDrag, &attributes);
451 wxTopLevelWindowMac* toplevel = wxFindWinFromMacWindow( theWindow ) ;
452
453 bool optionDown = GetCurrentKeyModifiers() & optionKey ;
454 wxDragResult result = optionDown ? wxDragCopy : wxDragMove;
455
456 switch(theMessage)
457 {
458 case kDragTrackingEnterHandler:
459 break;
460 case kDragTrackingLeaveHandler:
461 break;
462 case kDragTrackingEnterWindow:
463 trackingGlobals->m_currentTargetWindow = NULL ;
464 trackingGlobals->m_currentTarget = NULL ;
465 break;
466 case kDragTrackingInWindow:
467 if (toplevel == NULL)
468 break;
469
470 GetDragMouse(theDrag, &mouse, 0L);
471 localMouse = mouse;
472 GlobalToLocal(&localMouse);
473
474
475
476 // if (attributes & kDragHasLeftSenderWindow)
477 {
478 // wxPoint point(localMouse.h , localMouse.v) ;
479 wxWindow *win = NULL ;
480 ControlPartCode controlPart ;
481 ControlRef control = wxMacFindControlUnderMouse( toplevel , localMouse ,
482 theWindow , &controlPart ) ;
483 if ( control )
484 win = wxFindControlFromMacControl( control ) ;
485 // TODO toplevel->MacGetWindowFromPointSub( point , &win ) ;
486 int localx , localy ;
487 localx = localMouse.h ;
488 localy = localMouse.v ;
489 //TODO : should we use client coordinates
490 if ( win )
491 win->MacRootWindowToWindow( &localx , &localy ) ;
492 if ( win != trackingGlobals->m_currentTargetWindow )
493 {
494 if ( trackingGlobals->m_currentTargetWindow )
495 {
496 // this window is left
497 if ( trackingGlobals->m_currentTarget )
498 {
499 HideDragHilite(theDrag);
500 trackingGlobals->m_currentTarget->SetCurrentDrag( theDrag ) ;
501 trackingGlobals->m_currentTarget->OnLeave() ;
502 trackingGlobals->m_currentTarget = NULL;
503 trackingGlobals->m_currentTargetWindow = NULL ;
504 }
505 }
506 if ( win )
507 {
508 // this window is entered
509 trackingGlobals->m_currentTargetWindow = win ;
510 trackingGlobals->m_currentTarget = win->GetDropTarget() ;
511 {
512
513 if ( trackingGlobals->m_currentTarget )
514 {
515 trackingGlobals->m_currentTarget->SetCurrentDrag( theDrag ) ;
516 result = trackingGlobals->m_currentTarget->OnEnter(
517 localx , localy , result ) ;
518 }
519
520
521 if ( result != wxDragNone )
522 {
523 int x , y ;
524 x = y = 0 ;
525 win->MacWindowToRootWindow( &x , &y ) ;
526 RgnHandle hiliteRgn = NewRgn() ;
527 Rect r = { y , x , y+win->GetSize().y , x+win->GetSize().x } ;
528 RectRgn( hiliteRgn , &r ) ;
529 ShowDragHilite(theDrag, hiliteRgn, true);
530 DisposeRgn( hiliteRgn ) ;
531 }
532 }
533 }
534 }
535 else
536 {
537 if( trackingGlobals->m_currentTarget )
538 {
539 trackingGlobals->m_currentTarget->SetCurrentDrag( theDrag ) ;
540 trackingGlobals->m_currentTarget->OnDragOver(
541 localx , localy , result ) ;
542 }
543 }
544
545 // set cursor for OnEnter and OnDragOver
546 if ( trackingGlobals->m_currentSource && trackingGlobals->m_currentSource->GiveFeedback( result ) == FALSE )
547 {
548 if ( trackingGlobals->m_currentSource->MacInstallDefaultCursor( result ) == FALSE )
549 {
550 switch( result )
551 {
552 case wxDragCopy :
553 {
554 wxCursor cursor(wxCURSOR_COPY_ARROW) ;
555 cursor.MacInstall() ;
556 }
557 break ;
558 case wxDragMove :
559 {
560 wxCursor cursor(wxCURSOR_ARROW) ;
561 cursor.MacInstall() ;
562 }
563 break ;
564 case wxDragNone :
565 {
566 wxCursor cursor(wxCURSOR_NO_ENTRY) ;
567 cursor.MacInstall() ;
568 }
569 break ;
570
571 case wxDragError:
572 case wxDragLink:
573 case wxDragCancel:
574 // put these here to make gcc happy
575 ;
576 }
577 }
578 }
579
580 }
581 // MyTrackItemUnderMouse(localMouse, theWindow);
582 break;
583 case kDragTrackingLeaveWindow:
584 if (trackingGlobals->m_currentTarget)
585 {
586 trackingGlobals->m_currentTarget->SetCurrentDrag( theDrag ) ;
587 trackingGlobals->m_currentTarget->OnLeave() ;
588 HideDragHilite(theDrag);
589 trackingGlobals->m_currentTarget = NULL ;
590 }
591 trackingGlobals->m_currentTargetWindow = NULL ;
592 break;
593 }
594 return(noErr);
595 }
596
597 pascal OSErr wxMacWindowDragReceiveHandler(WindowPtr theWindow,
598 void *handlerRefCon,
599 DragReference theDrag)
600 {
601 MacTrackingGlobals* trackingGlobals = (MacTrackingGlobals*) handlerRefCon;
602 if ( trackingGlobals->m_currentTarget )
603 {
604 Point mouse,localMouse ;
605 int localx,localy ;
606
607 trackingGlobals->m_currentTarget->SetCurrentDrag( theDrag ) ;
608 GetDragMouse(theDrag, &mouse, 0L);
609 localMouse = mouse;
610 GlobalToLocal(&localMouse);
611 localx = localMouse.h ;
612 localy = localMouse.v ;
613 //TODO : should we use client coordinates
614 if ( trackingGlobals->m_currentTargetWindow )
615 trackingGlobals->m_currentTargetWindow->MacRootWindowToWindow( &localx , &localy ) ;
616 if ( trackingGlobals->m_currentTarget->OnDrop( localx , localy ) )
617 {
618 bool optionDown = GetCurrentKeyModifiers() & optionKey ;
619 wxDragResult result = optionDown ? wxDragCopy : wxDragMove;
620 trackingGlobals->m_currentTarget->OnData( localx , localy , result ) ;
621 }
622 }
623 return(noErr);
624 }
625 #endif