svtools/source/misc/transfer2.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <osl/mutex.hxx>
  21 #include <unotools/ucbstreamhelper.hxx>
  22 #include <sot/exchange.hxx>
  23 #include <sot/storage.hxx>
  24 #include <vcl/bitmap.hxx>
  25 #include <vcl/gdimtf.hxx>
  26 #include <vcl/graph.hxx>
  27 #include <vcl/svapp.hxx>
  28 #include <vcl/window.hxx>
  29 #include <comphelper/processfactory.hxx>
  30 #include <com/sun/star/datatransfer/dnd/XDropTargetDragContext.hpp>
  31 #include "svl/urlbmk.hxx"
  32 #include <svtools/inetimg.hxx>
  33 #include <svtools/imap.hxx>
  34 #include <svtools/transfer.hxx>
  35
  36 // --------------
  37 // - Namespaces -
  38 // --------------
  39
  40 using namespace ::com::sun::star::uno;
  41 using namespace ::com::sun::star::lang;
  42 using namespace ::com::sun::star::io;
  43 using namespace ::com::sun::star::datatransfer;
  44 using namespace ::com::sun::star::datatransfer::clipboard;
  45 using namespace ::com::sun::star::datatransfer::dnd;
  46
  47 // -----------------------------------------
  48 // - DragSourceHelper::DragGestureListener -
  49 // -----------------------------------------
  50
  51 DragSourceHelper::DragGestureListener::DragGestureListener( DragSourceHelper& rDragSourceHelper ) :
  52     mrParent( rDragSourceHelper )
  53 {
  54 }
  55
  56 // -----------------------------------------------------------------------------
  57
  58 DragSourceHelper::DragGestureListener::~DragGestureListener()
  59 {
  60 }
  61
  62 // -----------------------------------------------------------------------------
  63
  64 void SAL_CALL DragSourceHelper::DragGestureListener::disposing( const EventObject& ) throw( RuntimeException )
  65 {
  66 }
  67
  68 // -----------------------------------------------------------------------------
  69
  70 void SAL_CALL DragSourceHelper::DragGestureListener::dragGestureRecognized( const DragGestureEvent& rDGE ) throw( RuntimeException )
  71 {
  72     const SolarMutexGuard aGuard;
  73
  74     const Point aPtPixel( rDGE.DragOriginX, rDGE.DragOriginY );
  75     mrParent.StartDrag( rDGE.DragAction, aPtPixel );
  76 }
  77
  78 // --------------------
  79 // - DragSourceHelper -
  80 // --------------------
  81
  82 DragSourceHelper::DragSourceHelper( Window* pWindow ) :
  83     mxDragGestureRecognizer( pWindow->GetDragGestureRecognizer() )
  84 {
  85     if( mxDragGestureRecognizer.is() )
  86     {
  87         mxDragGestureListener = new DragSourceHelper::DragGestureListener( *this );
  88         mxDragGestureRecognizer->addDragGestureListener( mxDragGestureListener );
  89     }
  90 }
  91
  92 // -----------------------------------------------------------------------------
  93
  94 DragSourceHelper::~DragSourceHelper()
  95 {
  96     if( mxDragGestureRecognizer.is()  )
  97         mxDragGestureRecognizer->removeDragGestureListener( mxDragGestureListener );
  98 }
  99
 100 // -----------------------------------------------------------------------------
 101
 102 void DragSourceHelper::StartDrag( sal_Int8, const Point& )
 103 {
 104 }
 105
 106 // ----------------------------------------
 107 // - DropTargetHelper::DropTargetListener -
 108 // ----------------------------------------
 109
 110 DropTargetHelper::DropTargetListener::DropTargetListener( DropTargetHelper& rDropTargetHelper ) :
 111     mrParent( rDropTargetHelper ),
 112     mpLastDragOverEvent( NULL )
 113 {
 114 }
 115
 116 // -----------------------------------------------------------------------------
 117
 118 DropTargetHelper::DropTargetListener::~DropTargetListener()
 119 {
 120     delete mpLastDragOverEvent;
 121 }
 122
 123 // -----------------------------------------------------------------------------
 124
 125 void SAL_CALL DropTargetHelper::DropTargetListener::disposing( const EventObject& ) throw( RuntimeException )
 126 {
 127 }
 128
 129 // -----------------------------------------------------------------------------
 130
 131 void SAL_CALL DropTargetHelper::DropTargetListener::drop( const DropTargetDropEvent& rDTDE ) throw( RuntimeException )
 132 {
 133     const SolarMutexGuard aGuard;
 134
 135     try
 136     {
 137         AcceptDropEvent  aAcceptEvent;
 138         ExecuteDropEvent aExecuteEvt( rDTDE.DropAction & ~DNDConstants::ACTION_DEFAULT, Point( rDTDE.LocationX, rDTDE.LocationY ), rDTDE );
 139         sal_Int8         nRet = DNDConstants::ACTION_NONE;
 140
 141         aExecuteEvt.mbDefault = ( ( rDTDE.DropAction & DNDConstants::ACTION_DEFAULT ) != 0 );
 142
 143         // in case of a default action, call ::AcceptDrop first and use the returned
 144         // accepted action as the execute action in the call to ::ExecuteDrop
 145         aAcceptEvent.mnAction = aExecuteEvt.mnAction;
 146         aAcceptEvent.maPosPixel = aExecuteEvt.maPosPixel;
 147         (DropTargetEvent&)( aAcceptEvent.maDragEvent ) = (DropTargetEvent&) rDTDE;
 148         ( (DropTargetDragEvent&)( aAcceptEvent.maDragEvent ) ).DropAction = rDTDE.DropAction;
 149         ( (DropTargetDragEvent&)( aAcceptEvent.maDragEvent ) ).LocationX = rDTDE.LocationX;
 150         ( (DropTargetDragEvent&)( aAcceptEvent.maDragEvent ) ).LocationY = rDTDE.LocationY;
 151         ( (DropTargetDragEvent&)( aAcceptEvent.maDragEvent ) ).SourceActions = rDTDE.SourceActions;
 152         aAcceptEvent.mbLeaving = sal_False;
 153         aAcceptEvent.mbDefault = aExecuteEvt.mbDefault;
 154
 155         nRet = mrParent.AcceptDrop( aAcceptEvent );
 156
 157         if( DNDConstants::ACTION_NONE != nRet )
 158         {
 159             rDTDE.Context->acceptDrop( nRet );
 160
 161             if( aExecuteEvt.mbDefault )
 162                 aExecuteEvt.mnAction = nRet;
 163
 164             nRet = mrParent.ExecuteDrop( aExecuteEvt );
 165         }
 166
 167         rDTDE.Context->dropComplete( DNDConstants::ACTION_NONE != nRet );
 168
 169         if( mpLastDragOverEvent )
 170         {
 171             delete mpLastDragOverEvent;
 172             mpLastDragOverEvent = NULL;
 173         }
 174     }
 175     catch( const ::com::sun::star::uno::Exception& )
 176     {
 177     }
 178 }
 179
 180 // -----------------------------------------------------------------------------
 181
 182 void SAL_CALL DropTargetHelper::DropTargetListener::dragEnter( const DropTargetDragEnterEvent& rDTDEE ) throw( RuntimeException )
 183 {
 184     const SolarMutexGuard aGuard;
 185
 186     try
 187     {
 188         mrParent.ImplBeginDrag( rDTDEE.SupportedDataFlavors );
 189     }
 190     catch( const ::com::sun::star::uno::Exception& )
 191     {
 192     }
 193
 194     dragOver( rDTDEE );
 195 }
 196
 197 // -----------------------------------------------------------------------------
 198
 199 void SAL_CALL DropTargetHelper::DropTargetListener::dragOver( const DropTargetDragEvent& rDTDE ) throw( RuntimeException )
 200 {
 201     const SolarMutexGuard aGuard;
 202
 203     try
 204     {
 205         if( mpLastDragOverEvent )
 206             delete mpLastDragOverEvent;
 207
 208         mpLastDragOverEvent = new AcceptDropEvent( rDTDE.DropAction & ~DNDConstants::ACTION_DEFAULT, Point( rDTDE.LocationX, rDTDE.LocationY ), rDTDE );
 209         mpLastDragOverEvent->mbDefault = ( ( rDTDE.DropAction & DNDConstants::ACTION_DEFAULT ) != 0 );
 210
 211         const sal_Int8 nRet = mrParent.AcceptDrop( *mpLastDragOverEvent );
 212
 213         if( DNDConstants::ACTION_NONE == nRet )
 214             rDTDE.Context->rejectDrag();
 215         else
 216             rDTDE.Context->acceptDrag( nRet );
 217     }
 218     catch( const ::com::sun::star::uno::Exception& )
 219     {
 220     }
 221 }
 222
 223 // -----------------------------------------------------------------------------
 224
 225 void SAL_CALL DropTargetHelper::DropTargetListener::dragExit( const DropTargetEvent& ) throw( RuntimeException )
 226 {
 227     const SolarMutexGuard aGuard;
 228
 229     try
 230     {
 231         if( mpLastDragOverEvent )
 232         {
 233             mpLastDragOverEvent->mbLeaving = sal_True;
 234             mrParent.AcceptDrop( *mpLastDragOverEvent );
 235             delete mpLastDragOverEvent;
 236             mpLastDragOverEvent = NULL;
 237         }
 238
 239         mrParent.ImplEndDrag();
 240     }
 241     catch( const ::com::sun::star::uno::Exception& )
 242     {
 243     }
 244 }
 245
 246
 247 // -----------------------------------------------------------------------------
 248
 249 void SAL_CALL DropTargetHelper::DropTargetListener::dropActionChanged( const DropTargetDragEvent& ) throw( RuntimeException )
 250 {
 251 }
 252
 253 // --------------------
 254 // - DropTargetHelper -
 255 // --------------------
 256
 257 DropTargetHelper::DropTargetHelper( Window* pWindow ) :
 258     mxDropTarget( pWindow->GetDropTarget() ),
 259     mpFormats( new DataFlavorExVector )
 260 {
 261     ImplConstruct();
 262 }
 263
 264 // -----------------------------------------------------------------------------
 265
 266 DropTargetHelper::DropTargetHelper( const Reference< XDropTarget >& rxDropTarget ) :
 267     mxDropTarget( rxDropTarget ),
 268     mpFormats( new DataFlavorExVector )
 269 {
 270     ImplConstruct();
 271 }
 272
 273 // -----------------------------------------------------------------------------
 274
 275 DropTargetHelper::~DropTargetHelper()
 276 {
 277     if( mxDropTarget.is() )
 278         mxDropTarget->removeDropTargetListener( mxDropTargetListener );
 279
 280     delete mpFormats;
 281 }
 282
 283 // -----------------------------------------------------------------------------
 284
 285 void DropTargetHelper::ImplConstruct()
 286 {
 287     if( mxDropTarget.is() )
 288     {
 289         mxDropTargetListener = new DropTargetHelper::DropTargetListener( *this );
 290         mxDropTarget->addDropTargetListener( mxDropTargetListener );
 291         mxDropTarget->setActive( sal_True );
 292     }
 293 }
 294
 295 // -----------------------------------------------------------------------------
 296
 297 void DropTargetHelper::ImplBeginDrag( const Sequence< DataFlavor >& rSupportedDataFlavors )
 298 {
 299     mpFormats->clear();
 300     TransferableDataHelper::FillDataFlavorExVector( rSupportedDataFlavors, *mpFormats );
 301 }
 302
 303 // -----------------------------------------------------------------------------
 304
 305 void DropTargetHelper::ImplEndDrag()
 306 {
 307     mpFormats->clear();
 308 }
 309
 310 // -----------------------------------------------------------------------------
 311
 312 sal_Int8 DropTargetHelper::AcceptDrop( const AcceptDropEvent& )
 313 {
 314     return( DNDConstants::ACTION_NONE );
 315 }
 316
 317 // -----------------------------------------------------------------------------
 318
 319 sal_Int8 DropTargetHelper::ExecuteDrop( const ExecuteDropEvent& )
 320 {
 321     return( DNDConstants::ACTION_NONE );
 322 }
 323
 324 // -----------------------------------------------------------------------------
 325
 326 sal_Bool DropTargetHelper::IsDropFormatSupported( SotFormatStringId nFormat )
 327 {
 328     DataFlavorExVector::iterator    aIter( mpFormats->begin() ), aEnd( mpFormats->end() );
 329     sal_Bool                        bRet = sal_False;
 330
 331     while( aIter != aEnd )
 332     {
 333         if( nFormat == (*aIter++).mnSotId )
 334         {
 335             bRet = sal_True;
 336             aIter = aEnd;
 337         }
 338     }
 339
 340     return bRet;
 341 }
 342
 343 // -----------------------------------------------------------------------------
 344
 345 sal_Bool DropTargetHelper::IsDropFormatSupported( const DataFlavor& rFlavor )
 346 {
 347     DataFlavorExVector::iterator    aIter( mpFormats->begin() ), aEnd( mpFormats->end() );
 348     sal_Bool                        bRet = sal_False;
 349
 350     while( aIter != aEnd )
 351     {
 352         if( TransferableDataHelper::IsEqual( rFlavor, *aIter++ ) )
 353         {
 354             bRet = sal_True;
 355             aIter = aEnd;
 356         }
 357     }
 358
 359     return bRet;
 360 }
 361
 362 // -----------------------------------------------------------------------------
 363 // TransferDataContainer
 364 // -----------------------------------------------------------------------------
 365
 366 struct TDataCntnrEntry_Impl
 367 {
 368     ::com::sun::star::uno::Any aAny;
 369     SotFormatStringId nId;
 370 };
 371
 372 // -----------------------------------------------------------------------------
 373
 374 typedef ::std::list< TDataCntnrEntry_Impl > TDataCntnrEntryList;
 375
 376 // -----------------------------------------------------------------------------
 377
 378 struct TransferDataContainer_Impl
 379 {
 380     TDataCntnrEntryList aFmtList;
 381     Link aFinshedLnk;
 382     INetBookmark* pBookmk;
 383     Graphic* pGrf;
 384
 385     TransferDataContainer_Impl()
 386         : pBookmk( 0 ), pGrf( 0 )
 387     {
 388     }
 389
 390     ~TransferDataContainer_Impl()
 391     {
 392         delete pBookmk;
 393         delete pGrf;
 394     }
 395 };
 396
 397 // -----------------------------------------------------------------------------
 398
 399 TransferDataContainer::TransferDataContainer()
 400     : pImpl( new TransferDataContainer_Impl )
 401 {
 402 }
 403
 404 // -----------------------------------------------------------------------------
 405
 406 TransferDataContainer::~TransferDataContainer()
 407 {
 408     delete pImpl;
 409 }
 410
 411 // -----------------------------------------------------------------------------
 412
 413 void TransferDataContainer::AddSupportedFormats()
 414 {
 415 }
 416
 417 // -----------------------------------------------------------------------------
 418
 419 sal_Bool TransferDataContainer::GetData( const
 420             ::com::sun::star::datatransfer::DataFlavor& rFlavor )
 421 {
 422     TDataCntnrEntryList::iterator   aIter( pImpl->aFmtList.begin() ),
 423                                     aEnd( pImpl->aFmtList.end() );
 424     sal_Bool bFnd = sal_False;
 425     sal_uLong nFmtId = SotExchange::GetFormat( rFlavor );
 426
 427     // test first the list
 428     for( ; aIter != aEnd; ++aIter )
 429     {
 430         TDataCntnrEntry_Impl& rEntry = (TDataCntnrEntry_Impl&)*aIter;
 431         if( nFmtId == rEntry.nId )
 432         {
 433             bFnd = SetAny( rEntry.aAny, rFlavor );
 434             break;
 435         }
 436     }
 437
 438     // test second the bookmark pointer
 439     if( !bFnd )
 440         switch( nFmtId )
 441         {
 442          case SOT_FORMAT_STRING:
 443          case SOT_FORMATSTR_ID_SOLK:
 444          case SOT_FORMATSTR_ID_NETSCAPE_BOOKMARK:
 445          case SOT_FORMATSTR_ID_FILECONTENT:
 446          case SOT_FORMATSTR_ID_FILEGRPDESCRIPTOR:
 447          case SOT_FORMATSTR_ID_UNIFORMRESOURCELOCATOR:
 448             if( pImpl->pBookmk )
 449                 bFnd = SetINetBookmark( *pImpl->pBookmk, rFlavor );
 450             break;
 451
 452         case SOT_FORMATSTR_ID_SVXB:
 453         case SOT_FORMAT_BITMAP:
 454         case SOT_FORMAT_GDIMETAFILE:
 455             if( pImpl->pGrf )
 456                 bFnd = SetGraphic( *pImpl->pGrf, rFlavor );
 457             break;
 458         }
 459
 460     return bFnd;
 461 }
 462
 463 // -----------------------------------------------------------------------------
 464
 465 void TransferDataContainer::CopyINetBookmark( const INetBookmark& rBkmk )
 466 {
 467     if( !pImpl->pBookmk )
 468         pImpl->pBookmk = new INetBookmark( rBkmk );
 469     else
 470         *pImpl->pBookmk = rBkmk;
 471
 472      AddFormat( SOT_FORMAT_STRING );
 473      AddFormat( SOT_FORMATSTR_ID_SOLK );
 474      AddFormat( SOT_FORMATSTR_ID_NETSCAPE_BOOKMARK );
 475      AddFormat( SOT_FORMATSTR_ID_FILECONTENT );
 476      AddFormat( SOT_FORMATSTR_ID_FILEGRPDESCRIPTOR );
 477      AddFormat( SOT_FORMATSTR_ID_UNIFORMRESOURCELOCATOR );
 478 }
 479
 480 // -----------------------------------------------------------------------------
 481
 482 void TransferDataContainer::CopyAnyData( sal_uLong nFormatId,
 483                                         const sal_Char* pData, sal_uLong nLen )
 484 {
 485     if( nLen )
 486     {
 487         TDataCntnrEntry_Impl aEntry;
 488         aEntry.nId = nFormatId;
 489
 490         Sequence< sal_Int8 > aSeq( nLen  );
 491         memcpy( aSeq.getArray(), pData, nLen );
 492         aEntry.aAny <<= aSeq;
 493         pImpl->aFmtList.push_back( aEntry );
 494          AddFormat( nFormatId );
 495     }
 496 }
 497
 498 // -----------------------------------------------------------------------------
 499
 500 void TransferDataContainer::CopyByteString( sal_uLong nFormatId,
 501                                             const OString& rStr )
 502 {
 503     CopyAnyData( nFormatId, rStr.getStr(), rStr.getLength() );
 504 }
 505
 506 // -----------------------------------------------------------------------------
 507
 508 void TransferDataContainer::CopyINetImage( const INetImage& rINtImg )
 509 {
 510     SvMemoryStream aMemStm( 1024, 1024 );
 511     aMemStm.SetVersion( SOFFICE_FILEFORMAT_50 );
 512     rINtImg.Write( aMemStm, SOT_FORMATSTR_ID_INET_IMAGE );
 513     CopyAnyData( SOT_FORMATSTR_ID_INET_IMAGE, (sal_Char*)aMemStm.GetData(),
 514                     aMemStm.Seek( STREAM_SEEK_TO_END ) );
 515 }
 516
 517 // -----------------------------------------------------------------------------
 518
 519 void TransferDataContainer::CopyImageMap( const ImageMap& rImgMap )
 520 {
 521     SvMemoryStream aMemStm( 8192, 8192 );
 522     aMemStm.SetVersion( SOFFICE_FILEFORMAT_50 );
 523     rImgMap.Write( aMemStm, String() );
 524     CopyAnyData( SOT_FORMATSTR_ID_SVIM, (sal_Char*)aMemStm.GetData(),
 525                     aMemStm.Seek( STREAM_SEEK_TO_END ) );
 526 }
 527
 528 // -----------------------------------------------------------------------------
 529
 530 void TransferDataContainer::CopyGraphic( const Graphic& rGrf )
 531 {
 532     GraphicType nType = rGrf.GetType();
 533     if( GRAPHIC_NONE != nType )
 534     {
 535         if( !pImpl->pGrf )
 536             pImpl->pGrf = new Graphic( rGrf );
 537         else
 538             *pImpl->pGrf = rGrf;
 539
 540         AddFormat( SOT_FORMATSTR_ID_SVXB );
 541         if( GRAPHIC_BITMAP == nType )
 542             AddFormat( SOT_FORMAT_BITMAP );
 543         else if( GRAPHIC_GDIMETAFILE == nType )
 544             AddFormat( SOT_FORMAT_GDIMETAFILE );
 545     }
 546 }
 547
 548 // -----------------------------------------------------------------------------
 549
 550 void TransferDataContainer::CopyString( sal_uInt16 nFmt, const String& rStr )
 551 {
 552     if( rStr.Len() )
 553     {
 554         TDataCntnrEntry_Impl aEntry;
 555         aEntry.nId = nFmt;
 556         OUString aStr( rStr );
 557         aEntry.aAny <<= aStr;
 558         pImpl->aFmtList.push_back( aEntry );
 559          AddFormat( aEntry.nId );
 560     }
 561 }
 562
 563 // -----------------------------------------------------------------------------
 564
 565 void TransferDataContainer::CopyString( const String& rStr )
 566 {
 567     CopyString( SOT_FORMAT_STRING, rStr );
 568 }
 569
 570 // -----------------------------------------------------------------------------
 571
 572 void TransferDataContainer::CopyAny( sal_uInt16 nFmt,
 573                                     const ::com::sun::star::uno::Any& rAny )
 574 {
 575     TDataCntnrEntry_Impl aEntry;
 576     aEntry.nId = nFmt;
 577     aEntry.aAny = rAny;
 578     pImpl->aFmtList.push_back( aEntry );
 579     AddFormat( aEntry.nId );
 580 }
 581
 582 // -----------------------------------------------------------------------------
 583
 584 sal_Bool TransferDataContainer::HasAnyData() const
 585 {
 586     return pImpl->aFmtList.begin() != pImpl->aFmtList.end() ||
 587             0 != pImpl->pBookmk;
 588 }
 589
 590 // -----------------------------------------------------------------------------
 591
 592 void TransferDataContainer::StartDrag(
 593         Window* pWindow, sal_Int8 nDragSourceActions,
 594         const Link& rLnk, sal_Int32 nDragPointer, sal_Int32 nDragImage )
 595 {
 596     pImpl->aFinshedLnk = rLnk;
 597     TransferableHelper::StartDrag( pWindow, nDragSourceActions,
 598                                     nDragPointer, nDragImage );
 599 }
 600
 601 // -----------------------------------------------------------------------------
 602
 603 void TransferDataContainer::DragFinished( sal_Int8 nDropAction )
 604 {
 605     if( pImpl->aFinshedLnk.IsSet() )
 606         pImpl->aFinshedLnk.Call( &nDropAction );
 607 }
 608
 609 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */