sw/source/ui/vba/vbaapplication.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column:100 -*- */
   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 <com/sun/star/task/XStatusIndicatorSupplier.hpp>
  21 #include <com/sun/star/task/XStatusIndicator.hpp>
  22 #include <com/sun/star/util/thePathSettings.hpp>
  23 #include <com/sun/star/awt/XDevice.hpp>
  24
  25 #include "vbaapplication.hxx"
  26 #include "vbadocument.hxx"
  27 #include "vbafilterpropsfromformat.hxx"
  28 #include <sal/log.hxx>
  29 #include <osl/file.hxx>
  30 #include <vcl/svapp.hxx>
  31 #include <vbahelper/vbahelper.hxx>
  32 #include "vbawindow.hxx"
  33 #include "vbasystem.hxx"
  34 #include "vbaoptions.hxx"
  35 #include "vbaselection.hxx"
  36 #include "vbadocuments.hxx"
  37 #include "vbaaddins.hxx"
  38 #include "vbamailmerge.hxx"
  39 #include "vbadialogs.hxx"
  40 #include "vbawordbasic.hxx"
  41 #include <ooo/vba/XConnectionPoint.hpp>
  42 #include <ooo/vba/word/WdEnableCancelKey.hpp>
  43 #include <ooo/vba/word/WdWindowState.hpp>
  44 #include <ooo/vba/word/XApplicationOutgoing.hpp>
  45 #include <ooo/vba/word/XBookmarks.hpp>
  46 #include <comphelper/processfactory.hxx>
  47 #include <comphelper/propertyvalue.hxx>
  48 #include <cppu/unotype.hxx>
  49 #include <editeng/acorrcfg.hxx>
  50 #include <swdll.hxx>
  51 #include <swmodule.hxx>
  52 #include <unotxdoc.hxx>
  53 #include "vbalistgalleries.hxx"
  54 #include <tools/urlobj.hxx>
  55
  56 using namespace ::ooo;
  57 using namespace ::ooo::vba;
  58 using namespace ::ooo::vba::word;
  59 using namespace ::com::sun::star;
  60
  61 namespace {
  62
  63 class SwVbaApplicationOutgoingConnectionPoint : public cppu::WeakImplHelper<XConnectionPoint>
  64 {
  65 private:
  66     SwVbaApplication* mpApp;
  67
  68 public:
  69     SwVbaApplicationOutgoingConnectionPoint( SwVbaApplication* pApp );
  70
  71     // XConnectionPoint
  72     sal_uInt32 SAL_CALL Advise(const uno::Reference< XSink >& Sink ) override;
  73     void SAL_CALL Unadvise( sal_uInt32 Cookie ) override;
  74 };
  75
  76 }
  77
  78 SwVbaApplication::SwVbaApplication( uno::Reference<uno::XComponentContext >& xContext ):
  79     SwVbaApplication_BASE( xContext )
  80 {
  81 }
  82
  83 SwVbaApplication::~SwVbaApplication()
  84 {
  85 }
  86
  87 sal_uInt32
  88 SwVbaApplication::AddSink( const uno::Reference< XSink >& xSink )
  89 {
  90     {
  91         SolarMutexGuard aGuard;
  92         SwGlobals::ensure();
  93     }
  94     // No harm in potentially calling this several times
  95     SwModule::get()->RegisterAutomationApplicationEventsCaller(uno::Reference<XSinkCaller>(this));
  96     mvSinks.push_back(xSink);
  97     return mvSinks.size();
  98 }
  99
 100 void
 101 SwVbaApplication::RemoveSink( sal_uInt32 nNumber )
 102 {
 103     if (nNumber < 1 || nNumber > mvSinks.size())
 104         return;
 105
 106     mvSinks[nNumber-1] = uno::Reference< XSink >();
 107 }
 108
 109 OUString SAL_CALL
 110 SwVbaApplication::getName()
 111 {
 112     return u"Microsoft Word"_ustr;
 113 }
 114
 115 uno::Reference< word::XDocument > SAL_CALL
 116 SwVbaApplication::getActiveDocument()
 117 {
 118     return new SwVbaDocument( this, mxContext, getCurrentSwDocument() );
 119 }
 120
 121 rtl::Reference<SwVbaWindow>
 122 SwVbaApplication::getActiveSwVbaWindow()
 123 {
 124     // #FIXME so far can't determine Parent
 125     rtl::Reference< SwXTextDocument > xModel( getCurrentSwDocument() );
 126     uno::Reference< frame::XController > xController( xModel->getCurrentController(), uno::UNO_SET_THROW );
 127     return new SwVbaWindow( uno::Reference< XHelperInterface >(), mxContext, xModel, xController );
 128 }
 129
 130 uno::Reference< css::uno::XComponentContext > const &
 131 SwVbaApplication::getContext() const
 132 {
 133     return mxContext;
 134 }
 135
 136 uno::Reference< word::XWindow > SAL_CALL
 137 SwVbaApplication::getActiveWindow()
 138 {
 139     return getActiveSwVbaWindow();
 140 }
 141
 142 uno::Reference<word::XSystem > SAL_CALL
 143 SwVbaApplication::getSystem()
 144 {
 145     return uno::Reference< word::XSystem >( new SwVbaSystem( mxContext ) );
 146 }
 147
 148 uno::Reference<word::XOptions > SAL_CALL
 149 SwVbaApplication::getOptions()
 150 {
 151     return uno::Reference< word::XOptions >( new SwVbaOptions( mxContext ) );
 152 }
 153
 154 uno::Any SAL_CALL
 155 SwVbaApplication::CommandBars( const uno::Any& aIndex )
 156 {
 157     try
 158     {
 159         return VbaApplicationBase::CommandBars( aIndex );
 160     }
 161     catch (const uno::RuntimeException&)
 162     {
 163         return uno::Any();
 164     }
 165 }
 166
 167 uno::Reference< word::XSelection > SAL_CALL
 168 SwVbaApplication::getSelection()
 169 {
 170     return new SwVbaSelection( this, mxContext, getCurrentSwDocument() );
 171 }
 172
 173 uno::Reference< word::XWordBasic > SAL_CALL
 174 SwVbaApplication::getWordBasic()
 175 {
 176     uno::Reference< word::XWordBasic > xWB( new SwWordBasic( this ) );
 177     return xWB;
 178 }
 179
 180 uno::Any SAL_CALL
 181 SwVbaApplication::Documents( const uno::Any& index )
 182 {
 183     uno::Reference< XCollection > xCol( new SwVbaDocuments( this, mxContext ) );
 184     if ( index.hasValue() )
 185         return xCol->Item( index, uno::Any() );
 186     return uno::Any( xCol );
 187 }
 188
 189 uno::Any SAL_CALL
 190 SwVbaApplication::Addins( const uno::Any& index )
 191 {
 192     static uno::Reference< XCollection > xCol( new SwVbaAddins( this, mxContext ) );
 193     if ( index.hasValue() )
 194         return xCol->Item( index, uno::Any() );
 195     return uno::Any( xCol );
 196 }
 197
 198 uno::Any SAL_CALL
 199 SwVbaApplication::Dialogs( const uno::Any& index )
 200 {
 201     uno::Reference< word::XDialogs > xCol( new SwVbaDialogs( this, mxContext, getCurrentSwDocument() ));
 202     if ( index.hasValue() )
 203         return xCol->Item( index );
 204     return uno::Any( xCol );
 205 }
 206
 207 uno::Any SAL_CALL
 208 SwVbaApplication::ListGalleries( const uno::Any& index )
 209 {
 210     rtl::Reference< SwXTextDocument > xTextDoc( getCurrentSwDocument() );
 211     uno::Reference< XCollection > xCol( new SwVbaListGalleries( this, mxContext, xTextDoc ) );
 212     if ( index.hasValue() )
 213         return xCol->Item( index, uno::Any() );
 214     return uno::Any( xCol );
 215 }
 216
 217 sal_Bool SAL_CALL SwVbaApplication::getDisplayAutoCompleteTips()
 218 {
 219     return SvxAutoCorrCfg::Get().IsAutoTextTip();
 220 }
 221
 222 void SAL_CALL SwVbaApplication::setDisplayAutoCompleteTips( sal_Bool _displayAutoCompleteTips )
 223 {
 224     SvxAutoCorrCfg::Get().SetAutoTextTip( _displayAutoCompleteTips );
 225 }
 226
 227 sal_Int32 SAL_CALL SwVbaApplication::getEnableCancelKey()
 228 {
 229     // the default value is wdCancelInterrupt in Word
 230     return word::WdEnableCancelKey::wdCancelInterrupt;
 231 }
 232
 233 void SAL_CALL SwVbaApplication::setEnableCancelKey( sal_Int32/* _enableCancelKey */)
 234 {
 235     // seems not supported in Writer
 236 }
 237
 238 sal_Int32 SAL_CALL SwVbaApplication::getWindowState()
 239 {
 240     auto xWindow = getActiveWindow();
 241     if (xWindow.is())
 242     {
 243         uno::Any aState = xWindow->getWindowState();
 244         sal_Int32 nState;
 245         if (aState >>= nState)
 246             return nState;
 247     }
 248
 249     return word::WdWindowState::wdWindowStateNormal; // ?
 250 }
 251
 252 void SAL_CALL SwVbaApplication::setWindowState( sal_Int32 _windowstate )
 253 {
 254     try
 255     {
 256         auto xWindow = getActiveWindow();
 257         if (xWindow.is())
 258         {
 259             uno::Any aState;
 260             aState <<= _windowstate;
 261             xWindow->setWindowState( aState );
 262         }
 263     }
 264     catch (const uno::RuntimeException&)
 265     {
 266     }
 267 }
 268
 269 sal_Int32 SAL_CALL SwVbaApplication::getWidth()
 270 {
 271     auto pWindow = getActiveSwVbaWindow();
 272     return pWindow->getWidth();
 273 }
 274
 275 void SAL_CALL SwVbaApplication::setWidth( sal_Int32 _width )
 276 {
 277     auto pWindow = getActiveSwVbaWindow();
 278     pWindow->setWidth( _width );
 279 }
 280
 281 sal_Int32 SAL_CALL SwVbaApplication::getHeight()
 282 {
 283     auto pWindow = getActiveSwVbaWindow();
 284     return pWindow->getHeight();
 285 }
 286
 287 void SAL_CALL SwVbaApplication::setHeight( sal_Int32 _height )
 288 {
 289     auto pWindow = getActiveSwVbaWindow();
 290     pWindow->setHeight( _height );
 291 }
 292
 293 sal_Int32 SAL_CALL SwVbaApplication::getLeft()
 294 {
 295     auto pWindow = getActiveSwVbaWindow();
 296     return pWindow->getLeft();
 297 }
 298
 299 void SAL_CALL SwVbaApplication::setLeft( sal_Int32 _left )
 300 {
 301     auto pWindow = getActiveSwVbaWindow();
 302     pWindow->setLeft( _left );
 303 }
 304
 305 sal_Int32 SAL_CALL SwVbaApplication::getTop()
 306 {
 307     auto pWindow = getActiveSwVbaWindow();
 308     return pWindow->getTop();
 309 }
 310
 311 void SAL_CALL SwVbaApplication::setTop( sal_Int32 _top )
 312 {
 313     auto pWindow = getActiveSwVbaWindow();
 314     pWindow->setTop( _top );
 315 }
 316
 317 OUString SAL_CALL SwVbaApplication::getStatusBar()
 318 {
 319     return u""_ustr;
 320 }
 321
 322 uno::Any SAL_CALL SwVbaApplication::getCustomizationContext()
 323 {
 324     return uno::Any(); // ???
 325 }
 326
 327 void SAL_CALL SwVbaApplication::setCustomizationContext(const uno::Any& /*_customizationcontext*/)
 328 {
 329     // ???
 330 }
 331
 332 void SAL_CALL SwVbaApplication::setStatusBar( const OUString& _statusbar )
 333 {
 334     // ScVbaAppSettings::setStatusBar() also uses the XStatusIndicator to show this, so maybe that is OK?
 335     rtl::Reference< SwXTextDocument > xModel = getCurrentSwDocument();
 336     if (xModel.is())
 337     {
 338         uno::Reference< task::XStatusIndicatorSupplier > xStatusIndicatorSupplier( xModel->getCurrentController(), uno::UNO_QUERY );
 339         if (xStatusIndicatorSupplier.is())
 340         {
 341             uno::Reference< task::XStatusIndicator > xStatusIndicator = xStatusIndicatorSupplier->getStatusIndicator();
 342             if (xStatusIndicator.is())
 343                 xStatusIndicator->start( _statusbar, 100 );
 344         }
 345     }
 346
 347     // Yes, we intentionally use the "extensions.olebridge" tag here even if this is sw. We
 348     // interpret setting the StatusBar property as a request from an Automation client to display
 349     // the string in LibreOffice's debug output, and all other generic Automation support debug
 350     // output (in extensions/source/ole) uses that tag. If the check for "cross-module" or mixed log
 351     // areas in compilerplugins/clang/sallogareas.cxx is re-activated, this will have to be added as
 352     // a special case.
 353
 354     SAL_INFO("extensions.olebridge", "Client debug output: " << _statusbar);
 355 }
 356
 357 float SAL_CALL SwVbaApplication::CentimetersToPoints( float Centimeters )
 358 {
 359     return o3tl::convert(Centimeters, o3tl::Length::cm, o3tl::Length::pt);
 360 }
 361
 362 float SAL_CALL SwVbaApplication::PointsToCentimeters( float Points )
 363 {
 364     return o3tl::convert(Points, o3tl::Length::pt, o3tl::Length::cm);
 365 }
 366
 367 float SAL_CALL SwVbaApplication::PixelsToPoints( float Pixels, ::sal_Bool fVertical )
 368 {
 369     //Set up xDevice
 370     rtl::Reference< SwXTextDocument > xModel( getCurrentSwDocument() );
 371     uno::Reference< frame::XController > xController( xModel->getCurrentController(), uno::UNO_SET_THROW );
 372     uno::Reference< frame::XFrame > xFrame( xController->getFrame(), uno::UNO_SET_THROW );
 373     uno::Reference< awt::XWindow > xWindow( xFrame->getContainerWindow(), uno::UNO_SET_THROW );
 374     css::uno::Reference< css::awt::XDevice > xDevice( xWindow, css::uno::UNO_QUERY );
 375
 376     return ooo::vba::PixelsToPoints(xDevice, Pixels, fVertical);
 377 }
 378
 379 float SAL_CALL SwVbaApplication::PointsToPixels( float Pixels, ::sal_Bool fVertical )
 380 {
 381     rtl::Reference< SwXTextDocument > xModel( getCurrentSwDocument() );
 382     uno::Reference< frame::XController > xController( xModel->getCurrentController(), uno::UNO_SET_THROW );
 383     uno::Reference< frame::XFrame > xFrame( xController->getFrame(), uno::UNO_SET_THROW );
 384     uno::Reference< awt::XWindow > xWindow( xFrame->getContainerWindow(), uno::UNO_SET_THROW );
 385     css::uno::Reference< css::awt::XDevice > xDevice( xWindow, css::uno::UNO_QUERY );
 386
 387     return ooo::vba::PointsToPixels(xDevice, Pixels, fVertical);
 388 }
 389
 390 float SAL_CALL SwVbaApplication::InchesToPoints( float Inches )
 391 {
 392     return o3tl::convert(Inches, o3tl::Length::in, o3tl::Length::pt);
 393 }
 394
 395 float SAL_CALL SwVbaApplication::PointsToInches( float Points )
 396 {
 397     return o3tl::convert(Points, o3tl::Length::pt, o3tl::Length::in);
 398 }
 399
 400 float SAL_CALL SwVbaApplication::MillimetersToPoints( float Millimeters )
 401 {
 402     return o3tl::convert(Millimeters, o3tl::Length::mm, o3tl::Length::pt);
 403 }
 404
 405 float SAL_CALL SwVbaApplication::PointsToMillimeters( float Points )
 406 {
 407     return o3tl::convert(Points, o3tl::Length::pt, o3tl::Length::mm);
 408 }
 409
 410 float SAL_CALL SwVbaApplication::PicasToPoints( float Picas )
 411 {
 412     return o3tl::convert(Picas, o3tl::Length::pc, o3tl::Length::pt);
 413 }
 414
 415 float SAL_CALL SwVbaApplication::PointsToPicas( float Points )
 416 {
 417     return o3tl::convert(Points, o3tl::Length::pt, o3tl::Length::pc);
 418 }
 419
 420 void SAL_CALL SwVbaApplication::ShowMe()
 421 {
 422     // Method no longer supported in word - deprecated
 423 }
 424
 425 void SAL_CALL SwVbaApplication::Resize( sal_Int32 Width, sal_Int32 Height )
 426 {
 427     // Have to do it like this as the Width and Height are hidden away in the ooo::vba::XWindowBase
 428     // which ooo::vba::word::XApplication does not inherit from. SwVbaWindow, however, does inherit
 429     // from XWindowBase. Ugh.
 430     auto pWindow = getActiveSwVbaWindow();
 431     pWindow->setWidth( Width );
 432     pWindow->setHeight( Height );
 433 }
 434
 435 void SAL_CALL SwVbaApplication::Move( sal_Int32 Left, sal_Int32 Top )
 436 {
 437     // See comment in Resize().
 438     auto pWindow = getActiveSwVbaWindow();
 439     pWindow->setLeft( Left );
 440     pWindow->setTop( Top );
 441 }
 442
 443 // XInterfaceWithIID
 444
 445 OUString SAL_CALL
 446 SwVbaApplication::getIID()
 447 {
 448     return u"{82154421-0FBF-11d4-8313-005004526AB4}"_ustr;
 449 }
 450
 451 // XConnectable
 452
 453 OUString SAL_CALL
 454 SwVbaApplication::GetIIDForClassItselfNotCoclass()
 455 {
 456     return u"{82154423-0FBF-11D4-8313-005004526AB4}"_ustr;
 457 }
 458
 459 TypeAndIID SAL_CALL
 460 SwVbaApplication::GetConnectionPoint()
 461 {
 462     TypeAndIID aResult =
 463         { cppu::UnoType<word::XApplicationOutgoing>::get(),
 464           u"{82154422-0FBF-11D4-8313-005004526AB4}"_ustr
 465         };
 466
 467     return aResult;
 468 }
 469
 470 uno::Reference<XConnectionPoint> SAL_CALL
 471 SwVbaApplication::FindConnectionPoint()
 472 {
 473     uno::Reference<XConnectionPoint> xCP(new SwVbaApplicationOutgoingConnectionPoint(this));
 474     return xCP;
 475 }
 476
 477 OUString
 478 SwVbaApplication::getServiceImplName()
 479 {
 480     return u"SwVbaApplication"_ustr;
 481 }
 482
 483 uno::Sequence< OUString >
 484 SwVbaApplication::getServiceNames()
 485 {
 486     static uno::Sequence< OUString > const aServiceNames
 487     {
 488         u"ooo.vba.word.Application"_ustr
 489     };
 490     return aServiceNames;
 491 }
 492
 493 uno::Reference< frame::XModel >
 494 SwVbaApplication::getCurrentDocument()
 495 {
 496     return static_cast<SfxBaseModel*>(getCurrentWordDoc( mxContext ).get());
 497 }
 498
 499 rtl::Reference< SwXTextDocument >
 500 SwVbaApplication::getCurrentSwDocument()
 501 {
 502     return getCurrentWordDoc( mxContext );
 503 }
 504
 505 // XSinkCaller
 506
 507 void SAL_CALL
 508 SwVbaApplication::CallSinks( const OUString& Method, uno::Sequence< uno::Any >& Arguments )
 509 {
 510     for (auto& i : mvSinks)
 511     {
 512         if (i.is())
 513             i->Call(Method, Arguments);
 514     }
 515 }
 516
 517 // SwVbaApplicationOutgoingConnectionPoint
 518
 519 SwVbaApplicationOutgoingConnectionPoint::SwVbaApplicationOutgoingConnectionPoint( SwVbaApplication* pApp ) :
 520     mpApp(pApp)
 521 {
 522 }
 523
 524 // XConnectionPoint
 525 sal_uInt32 SAL_CALL
 526 SwVbaApplicationOutgoingConnectionPoint::Advise( const uno::Reference< XSink >& Sink )
 527 {
 528     return mpApp->AddSink(Sink);
 529 }
 530
 531 void SAL_CALL
 532 SwVbaApplicationOutgoingConnectionPoint::Unadvise( sal_uInt32 Cookie )
 533 {
 534     mpApp->RemoveSink( Cookie );
 535 }
 536
 537 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */