svx/source/svdraw/svdouno.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 <svx/sdr/contact/viewcontactofunocontrol.hxx>
  21 #include <svx/sdr/contact/viewobjectcontactofunocontrol.hxx>
  22 #include <com/sun/star/container/XChild.hpp>
  23 #include <com/sun/star/awt/XWindow.hpp>
  24 #include <com/sun/star/awt/PosSize.hpp>
  25 #include <com/sun/star/beans/XPropertySet.hpp>
  26 #include <com/sun/star/io/XPersistObject.hpp>
  27 #include <com/sun/star/io/XOutputStream.hpp>
  28 #include <com/sun/star/io/XInputStream.hpp>
  29 #include <com/sun/star/io/XActiveDataSink.hpp>
  30 #include <com/sun/star/io/XActiveDataSource.hpp>
  31 #include <com/sun/star/io/XObjectOutputStream.hpp>
  32 #include <com/sun/star/io/XObjectInputStream.hpp>
  33 #include <com/sun/star/util/XCloneable.hpp>
  34 #include <comphelper/processfactory.hxx>
  35 #include <comphelper/types.hxx>
  36 #include <vcl/pdfextoutdevdata.hxx>
  37 #include <svx/svdouno.hxx>
  38 #include <svx/svdpagv.hxx>
  39 #include <svx/svdmodel.hxx>
  40 #include "svx/svdglob.hxx"  // string cache
  41 #include "svx/svdstr.hrc"   // the object's name
  42 #include <svx/svdetc.hxx>
  43 #include <svx/svdview.hxx>
  44 #include <svx/svdorect.hxx>
  45 #include "svx/svdviter.hxx"
  46 #include <rtl/ref.hxx>
  47 #include <set>
  48 #include <memory>
  49 #include <svx/sdrpagewindow.hxx>
  50 #include <svx/sdrpaintwindow.hxx>
  51 #include <tools/diagnose_ex.h>
  52 #include <svx/svdograf.hxx>
  53
  54 using namespace ::com::sun::star;
  55 using namespace ::sdr::contact;
  56
  57 //************************************************************
  58 //   Defines
  59 //************************************************************
  60
  61 //************************************************************
  62 //   Helper class SdrControlEventListenerImpl
  63 //************************************************************
  64 #include <com/sun/star/lang/XEventListener.hpp>
  65
  66 #include <cppuhelper/implbase1.hxx>
  67
  68 // =============================================================================
  69 class SdrControlEventListenerImpl : public ::cppu::WeakImplHelper1< ::com::sun::star::lang::XEventListener >
  70 {
  71 protected:
  72     SdrUnoObj*                  pObj;
  73
  74 public:
  75     SdrControlEventListenerImpl(SdrUnoObj* _pObj)
  76     :   pObj(_pObj)
  77     {}
  78
  79     // XEventListener
  80     virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw(::com::sun::star::uno::RuntimeException);
  81
  82     void StopListening(const uno::Reference< lang::XComponent >& xComp);
  83     void StartListening(const uno::Reference< lang::XComponent >& xComp);
  84 };
  85
  86 // XEventListener
  87 void SAL_CALL SdrControlEventListenerImpl::disposing( const ::com::sun::star::lang::EventObject& /*Source*/)
  88     throw(::com::sun::star::uno::RuntimeException)
  89 {
  90     if (pObj)
  91     {
  92         pObj->xUnoControlModel = NULL;
  93     }
  94 }
  95
  96 void SdrControlEventListenerImpl::StopListening(const uno::Reference< lang::XComponent >& xComp)
  97 {
  98     if (xComp.is())
  99         xComp->removeEventListener(this);
 100 }
 101
 102 void SdrControlEventListenerImpl::StartListening(const uno::Reference< lang::XComponent >& xComp)
 103 {
 104     if (xComp.is())
 105         xComp->addEventListener(this);
 106 }
 107
 108 // =============================================================================
 109 struct SAL_DLLPRIVATE SdrUnoObjDataHolder
 110 {
 111     mutable ::rtl::Reference< SdrControlEventListenerImpl >
 112                                     pEventListener;
 113 };
 114
 115 // =============================================================================
 116 namespace
 117 {
 118     void lcl_ensureControlVisibility( SdrView* _pView, const SdrUnoObj* _pObject, bool _bVisible )
 119     {
 120         OSL_PRECOND( _pObject, "lcl_ensureControlVisibility: no object -> no survival!" );
 121
 122         SdrPageView* pPageView = _pView ? _pView->GetSdrPageView() : NULL;
 123         DBG_ASSERT( pPageView, "lcl_ensureControlVisibility: no view found!" );
 124         if ( !pPageView )
 125             return;
 126
 127         ViewContact& rUnoControlContact( _pObject->GetViewContact() );
 128
 129         for ( sal_uInt32 i = 0; i < pPageView->PageWindowCount(); ++i )
 130         {
 131             const SdrPageWindow* pPageWindow = pPageView->GetPageWindow( i );
 132             DBG_ASSERT( pPageWindow, "lcl_ensureControlVisibility: invalid PageViewWindow!" );
 133             if ( !pPageWindow )
 134                 continue;
 135
 136             if ( !pPageWindow->HasObjectContact() )
 137                 continue;
 138
 139             ObjectContact& rPageViewContact( pPageWindow->GetObjectContact() );
 140             const ViewObjectContact& rViewObjectContact( rUnoControlContact.GetViewObjectContact( rPageViewContact ) );
 141             const ViewObjectContactOfUnoControl* pUnoControlContact = dynamic_cast< const ViewObjectContactOfUnoControl* >( &rViewObjectContact );
 142             DBG_ASSERT( pUnoControlContact, "lcl_ensureControlVisibility: wrong ViewObjectContact type!" );
 143             if ( !pUnoControlContact )
 144                 continue;
 145
 146             pUnoControlContact->ensureControlVisibility( _bVisible );
 147         }
 148     }
 149 }
 150
 151 //************************************************************
 152 //   SdrUnoObj
 153 //************************************************************
 154
 155 TYPEINIT1(SdrUnoObj, SdrRectObj);
 156
 157 SdrUnoObj::SdrUnoObj(const String& rModelName, sal_Bool _bOwnUnoControlModel)
 158 :   m_pImpl( new SdrUnoObjDataHolder ),
 159     bOwnUnoControlModel( _bOwnUnoControlModel )
 160 {
 161     bIsUnoObj = sal_True;
 162
 163     m_pImpl->pEventListener = new SdrControlEventListenerImpl(this);
 164
 165     // only an owner may create independently
 166     if (rModelName.Len())
 167         CreateUnoControlModel(rModelName);
 168 }
 169
 170 SdrUnoObj::SdrUnoObj(const String& rModelName,
 171                      const uno::Reference< lang::XMultiServiceFactory >& rxSFac,
 172                      sal_Bool _bOwnUnoControlModel)
 173 :   m_pImpl( new SdrUnoObjDataHolder ),
 174     bOwnUnoControlModel( _bOwnUnoControlModel )
 175 {
 176     bIsUnoObj = sal_True;
 177
 178     m_pImpl->pEventListener = new SdrControlEventListenerImpl(this);
 179
 180     // only an owner may create independently
 181     if (rModelName.Len())
 182         CreateUnoControlModel(rModelName,rxSFac);
 183 }
 184
 185 SdrUnoObj::~SdrUnoObj()
 186 {
 187     try
 188     {
 189         // clean up the control model
 190         uno::Reference< lang::XComponent > xComp(xUnoControlModel, uno::UNO_QUERY);
 191         if (xComp.is())
 192         {
 193             // is the control model owned by its environment?
 194             uno::Reference< container::XChild > xContent(xUnoControlModel, uno::UNO_QUERY);
 195             if (xContent.is() && !xContent->getParent().is())
 196                 xComp->dispose();
 197             else
 198                 m_pImpl->pEventListener->StopListening(xComp);
 199         }
 200     }
 201     catch( const uno::Exception& )
 202     {
 203         OSL_FAIL( "SdrUnoObj::~SdrUnoObj: caught an exception!" );
 204     }
 205     delete m_pImpl;
 206 }
 207
 208 void SdrUnoObj::SetModel(SdrModel* pNewModel)
 209 {
 210     SdrRectObj::SetModel(pNewModel);
 211 }
 212
 213 void SdrUnoObj::SetPage(SdrPage* pNewPage)
 214 {
 215     SdrRectObj::SetPage(pNewPage);
 216 }
 217
 218 void SdrUnoObj::TakeObjInfo(SdrObjTransformInfoRec& rInfo) const
 219 {
 220     rInfo.bRotateFreeAllowed        =   sal_False;
 221     rInfo.bRotate90Allowed          =   sal_False;
 222     rInfo.bMirrorFreeAllowed        =   sal_False;
 223     rInfo.bMirror45Allowed          =   sal_False;
 224     rInfo.bMirror90Allowed          =   sal_False;
 225     rInfo.bTransparenceAllowed = sal_False;
 226     rInfo.bGradientAllowed = sal_False;
 227     rInfo.bShearAllowed             =   sal_False;
 228     rInfo.bEdgeRadiusAllowed        =   sal_False;
 229     rInfo.bNoOrthoDesired           =   sal_False;
 230     rInfo.bCanConvToPath            =   sal_False;
 231     rInfo.bCanConvToPoly            =   sal_False;
 232     rInfo.bCanConvToPathLineToArea  =   sal_False;
 233     rInfo.bCanConvToPolyLineToArea  =   sal_False;
 234     rInfo.bCanConvToContour = sal_False;
 235 }
 236
 237 sal_uInt16 SdrUnoObj::GetObjIdentifier() const
 238 {
 239     return sal_uInt16(OBJ_UNO);
 240 }
 241
 242 void SdrUnoObj::SetContextWritingMode( const sal_Int16 _nContextWritingMode )
 243 {
 244     try
 245     {
 246         uno::Reference< beans::XPropertySet > xModelProperties( GetUnoControlModel(), uno::UNO_QUERY_THROW );
 247         xModelProperties->setPropertyValue(
 248             OUString(  "ContextWritingMode"  ),
 249             uno::makeAny( _nContextWritingMode )
 250         );
 251     }
 252     catch( const uno::Exception& )
 253     {
 254         DBG_UNHANDLED_EXCEPTION();
 255     }
 256 }
 257
 258 void SdrUnoObj::TakeObjNameSingul(XubString& rName) const
 259 {
 260     rName = ImpGetResStr(STR_ObjNameSingulUno);
 261
 262     String aName( GetName() );
 263     if(aName.Len())
 264     {
 265         rName += sal_Unicode(' ');
 266         rName += sal_Unicode('\'');
 267         rName += aName;
 268         rName += sal_Unicode('\'');
 269     }
 270 }
 271
 272 void SdrUnoObj::TakeObjNamePlural(XubString& rName) const
 273 {
 274     rName = ImpGetResStr(STR_ObjNamePluralUno);
 275 }
 276
 277 SdrUnoObj* SdrUnoObj::Clone() const
 278 {
 279     return CloneHelper< SdrUnoObj >();
 280 }
 281
 282 SdrUnoObj& SdrUnoObj::operator= (const SdrUnoObj& rObj)
 283 {
 284     if( this == &rObj )
 285         return *this;
 286     SdrRectObj::operator= (rObj);
 287
 288     // release the reference to the current control model
 289     SetUnoControlModel( NULL );
 290
 291     aUnoControlModelTypeName = rObj.aUnoControlModelTypeName;
 292     aUnoControlTypeName = rObj.aUnoControlTypeName;
 293
 294     // copy the uno control model
 295     const uno::Reference< awt::XControlModel > xSourceControlModel( rObj.GetUnoControlModel(), uno::UNO_QUERY );
 296     if ( xSourceControlModel.is() )
 297     {
 298         try
 299         {
 300             uno::Reference< util::XCloneable > xClone( xSourceControlModel, uno::UNO_QUERY_THROW );
 301             xUnoControlModel.set( xClone->createClone(), uno::UNO_QUERY_THROW );
 302         }
 303         catch( const uno::Exception& )
 304         {
 305             DBG_UNHANDLED_EXCEPTION();
 306         }
 307     }
 308
 309     // get service name of the control from the control model
 310     uno::Reference< beans::XPropertySet > xSet(xUnoControlModel, uno::UNO_QUERY);
 311     if (xSet.is())
 312     {
 313         uno::Any aValue( xSet->getPropertyValue( OUString("DefaultControl")) );
 314         OUString aStr;
 315
 316         if( aValue >>= aStr )
 317             aUnoControlTypeName = String(aStr);
 318     }
 319
 320     uno::Reference< lang::XComponent > xComp(xUnoControlModel, uno::UNO_QUERY);
 321     if (xComp.is())
 322         m_pImpl->pEventListener->StartListening(xComp);
 323     return *this;
 324 }
 325
 326 void SdrUnoObj::NbcResize(const Point& rRef, const Fraction& xFact, const Fraction& yFact)
 327 {
 328     SdrRectObj::NbcResize(rRef,xFact,yFact);
 329
 330     if (aGeo.nShearWink!=0 || aGeo.nDrehWink!=0)
 331     {
 332         // small correctures
 333         if (aGeo.nDrehWink>=9000 && aGeo.nDrehWink<27000)
 334         {
 335             aRect.Move(aRect.Left()-aRect.Right(),aRect.Top()-aRect.Bottom());
 336         }
 337
 338         aGeo.nDrehWink  = 0;
 339         aGeo.nShearWink = 0;
 340         aGeo.nSin       = 0.0;
 341         aGeo.nCos       = 1.0;
 342         aGeo.nTan       = 0.0;
 343         SetRectsDirty();
 344     }
 345 }
 346
 347 // -----------------------------------------------------------------------------
 348
 349 bool SdrUnoObj::hasSpecialDrag() const
 350 {
 351     // no special drag; we have no rounding rect and
 352     // do want frame handles
 353     return false;
 354 }
 355
 356 bool SdrUnoObj::supportsFullDrag() const
 357 {
 358     // overloaded to have the possibility to enable/disable in debug and
 359     // to ckeck some things out. Current solution is working, so default is
 360     // enabled
 361     static bool bDoSupportFullDrag(true);
 362
 363     return bDoSupportFullDrag;
 364 }
 365
 366 SdrObject* SdrUnoObj::getFullDragClone() const
 367 {
 368     SdrObject* pRetval = 0;
 369     static bool bHandleSpecial(false);
 370
 371     if(bHandleSpecial)
 372     {
 373         // special handling for SdrUnoObj (FormControl). Create a SdrGrafObj
 374         // for drag containing the graphical representation. This does not work too
 375         // well, so the default is to simply clone
 376         pRetval = new SdrGrafObj(SdrDragView::GetObjGraphic(GetModel(), this), GetLogicRect());
 377     }
 378     else
 379     {
 380         // call parent (simply clone)
 381         pRetval = SdrRectObj::getFullDragClone();
 382     }
 383
 384     return pRetval;
 385 }
 386
 387 // -----------------------------------------------------------------------------
 388 void SdrUnoObj::NbcSetLayer( SdrLayerID _nLayer )
 389 {
 390     if ( GetLayer() == _nLayer )
 391     {   // redundant call -> not interested in doing anything here
 392         SdrRectObj::NbcSetLayer( _nLayer );
 393         return;
 394     }
 395
 396     // we need some special handling here in case we're moved from an invisible layer
 397     // to a visible one, or vice versa
 398     // (relative to a layer. Remember that the visibility of a layer is a view attribute
 399     // - the same layer can be visible in one view, and invisible in another view, at the
 400     // same time)
 401
 402     // collect all views in which our old layer is visible
 403     ::std::set< SdrView* > aPreviouslyVisible;
 404
 405     {
 406         SdrViewIter aIter( this );
 407         for ( SdrView* pView = aIter.FirstView(); pView; pView = aIter.NextView() )
 408             aPreviouslyVisible.insert( pView );
 409     }
 410
 411     SdrRectObj::NbcSetLayer( _nLayer );
 412
 413     // collect all views in which our new layer is visible
 414     ::std::set< SdrView* > aNewlyVisible;
 415
 416     {
 417         SdrViewIter aIter( this );
 418         for ( SdrView* pView = aIter.FirstView(); pView; pView = aIter.NextView() )
 419         {
 420             ::std::set< SdrView* >::const_iterator aPrevPos = aPreviouslyVisible.find( pView );
 421             if ( aPreviouslyVisible.end() != aPrevPos )
 422             {   // in pView, we were visible _before_ the layer change, and are
 423                 // visible _after_ the layer change, too
 424                 // -> we're not interested in this view at all
 425                 aPreviouslyVisible.erase( aPrevPos );
 426             }
 427             else
 428             {
 429                 // in pView, we were visible _before_ the layer change, and are
 430                 // _not_ visible after the layer change
 431                 // => remember this view, as our visibility there changed
 432                 aNewlyVisible.insert( pView );
 433             }
 434         }
 435     }
 436
 437     // now aPreviouslyVisible contains all views where we became invisible
 438     ::std::set< SdrView* >::const_iterator aLoopViews;
 439     for (   aLoopViews = aPreviouslyVisible.begin();
 440             aLoopViews != aPreviouslyVisible.end();
 441             ++aLoopViews
 442         )
 443     {
 444         lcl_ensureControlVisibility( *aLoopViews, this, false );
 445     }
 446
 447     // and aNewlyVisible all views where we became visible
 448     for (   aLoopViews = aNewlyVisible.begin();
 449             aLoopViews != aNewlyVisible.end();
 450             ++aLoopViews
 451         )
 452     {
 453         lcl_ensureControlVisibility( *aLoopViews, this, true );
 454     }
 455 }
 456
 457 void SdrUnoObj::CreateUnoControlModel(const String& rModelName)
 458 {
 459     DBG_ASSERT(!xUnoControlModel.is(), "model already exists");
 460
 461     aUnoControlModelTypeName = rModelName;
 462
 463     uno::Reference< awt::XControlModel >   xModel;
 464     uno::Reference< uno::XComponentContext > xContext( ::comphelper::getProcessComponentContext() );
 465     if (aUnoControlModelTypeName.Len() )
 466     {
 467         xModel = uno::Reference< awt::XControlModel >(xContext->getServiceManager()->createInstanceWithContext(
 468             aUnoControlModelTypeName, xContext), uno::UNO_QUERY);
 469
 470         if (xModel.is())
 471             SetChanged();
 472     }
 473
 474     SetUnoControlModel(xModel);
 475 }
 476
 477 void SdrUnoObj::CreateUnoControlModel(const String& rModelName,
 478                                       const uno::Reference< lang::XMultiServiceFactory >& rxSFac)
 479 {
 480     DBG_ASSERT(!xUnoControlModel.is(), "model already exists");
 481
 482     aUnoControlModelTypeName = rModelName;
 483
 484     uno::Reference< awt::XControlModel >   xModel;
 485     if (aUnoControlModelTypeName.Len() && rxSFac.is() )
 486     {
 487         xModel = uno::Reference< awt::XControlModel >(rxSFac->createInstance(
 488             aUnoControlModelTypeName), uno::UNO_QUERY);
 489
 490         if (xModel.is())
 491             SetChanged();
 492     }
 493
 494     SetUnoControlModel(xModel);
 495 }
 496
 497 void SdrUnoObj::SetUnoControlModel( const uno::Reference< awt::XControlModel >& xModel)
 498 {
 499     if (xUnoControlModel.is())
 500     {
 501         uno::Reference< lang::XComponent > xComp(xUnoControlModel, uno::UNO_QUERY);
 502         if (xComp.is())
 503             m_pImpl->pEventListener->StopListening(xComp);
 504     }
 505
 506     xUnoControlModel = xModel;
 507
 508     // control model has to contain service name of the control
 509     if (xUnoControlModel.is())
 510     {
 511         uno::Reference< beans::XPropertySet > xSet(xUnoControlModel, uno::UNO_QUERY);
 512         if (xSet.is())
 513         {
 514             uno::Any aValue( xSet->getPropertyValue(String("DefaultControl", osl_getThreadTextEncoding())) );
 515             OUString aStr;
 516             if( aValue >>= aStr )
 517                 aUnoControlTypeName = String(aStr);
 518         }
 519
 520         uno::Reference< lang::XComponent > xComp(xUnoControlModel, uno::UNO_QUERY);
 521         if (xComp.is())
 522             m_pImpl->pEventListener->StartListening(xComp);
 523     }
 524
 525     // invalidate all ViewObject contacts
 526     ViewContactOfUnoControl* pVC = NULL;
 527     if ( impl_getViewContact( pVC ) )
 528     {
 529         // flushViewObjectContacts() removes all existing VOCs for the local DrawHierarchy. This
 530         // is always allowed since they will be re-created on demand (and with the changed model)
 531         GetViewContact().flushViewObjectContacts(true);
 532     }
 533 }
 534
 535 //------------------------------------------------------------------------
 536 uno::Reference< awt::XControl > SdrUnoObj::GetUnoControl(const SdrView& _rView, const OutputDevice& _rOut) const
 537 {
 538     uno::Reference< awt::XControl > xControl;
 539
 540     SdrPageView* pPageView = _rView.GetSdrPageView();
 541     OSL_ENSURE( GetPage() == pPageView->GetPage(), "SdrUnoObj::GetUnoControl: This object is not displayed in that particular view!" );
 542     if ( GetPage() != pPageView->GetPage() )
 543         return NULL;
 544
 545     SdrPageWindow* pPageWindow = pPageView ? pPageView->FindPageWindow( _rOut ) : NULL;
 546     OSL_ENSURE( pPageWindow, "SdrUnoObj::GetUnoControl: did not find my SdrPageWindow!" );
 547     if ( !pPageWindow )
 548         return NULL;
 549
 550     ViewObjectContact& rViewObjectContact( GetViewContact().GetViewObjectContact( pPageWindow->GetObjectContact() ) );
 551     ViewObjectContactOfUnoControl* pUnoContact = dynamic_cast< ViewObjectContactOfUnoControl* >( &rViewObjectContact );
 552     OSL_ENSURE( pUnoContact, "SdrUnoObj::GetUnoControl: wrong contact type!" );
 553     if ( pUnoContact )
 554         xControl = pUnoContact->getControl();
 555
 556     return xControl;
 557 }
 558
 559 //------------------------------------------------------------------------
 560 uno::Reference< awt::XControl > SdrUnoObj::GetTemporaryControlForWindow(
 561     const Window& _rWindow, uno::Reference< awt::XControlContainer >& _inout_ControlContainer ) const
 562 {
 563     uno::Reference< awt::XControl > xControl;
 564
 565     ViewContactOfUnoControl* pVC = NULL;
 566     if ( impl_getViewContact( pVC ) )
 567         xControl = pVC->getTemporaryControlForWindow( _rWindow, _inout_ControlContainer );
 568
 569     return xControl;
 570 }
 571
 572 //------------------------------------------------------------------------
 573 bool SdrUnoObj::impl_getViewContact( ViewContactOfUnoControl*& _out_rpContact ) const
 574 {
 575     ViewContact& rViewContact( GetViewContact() );
 576     _out_rpContact = dynamic_cast< ViewContactOfUnoControl* >( &rViewContact );
 577     DBG_ASSERT( _out_rpContact, "SdrUnoObj::impl_getViewContact: could not find my ViewContact!" );
 578     return ( _out_rpContact != NULL );
 579 }
 580
 581 //------------------------------------------------------------------------
 582 ::sdr::contact::ViewContact* SdrUnoObj::CreateObjectSpecificViewContact()
 583 {
 584   return new ::sdr::contact::ViewContactOfUnoControl( *this );
 585 }
 586
 587
 588 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */