sfx2/source/view/viewprn.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
  21 #include <com/sun/star/document/XDocumentProperties.hpp>
  22 #include <com/sun/star/view/PrintableState.hpp>
  23 #include "com/sun/star/view/XRenderable.hpp"
  24
  25 #include <svl/itempool.hxx>
  26 #include <vcl/msgbox.hxx>
  27 #include <svtools/prnsetup.hxx>
  28 #include <svl/flagitem.hxx>
  29 #include <svl/stritem.hxx>
  30 #include <svl/intitem.hxx>
  31 #include <svl/eitem.hxx>
  32 #include <sfx2/app.hxx>
  33 #include <unotools/useroptions.hxx>
  34 #include <unotools/printwarningoptions.hxx>
  35 #include <tools/datetime.hxx>
  36 #include <sfx2/bindings.hxx>
  37 #include <sfx2/objface.hxx>
  38 #include <sfx2/viewsh.hxx>
  39 #include "viewimp.hxx"
  40 #include <sfx2/viewfrm.hxx>
  41 #include <sfx2/prnmon.hxx>
  42 #include "sfx2/sfxresid.hxx"
  43 #include <sfx2/request.hxx>
  44 #include <sfx2/objsh.hxx>
  45 #include "sfxtypes.hxx"
  46 #include <sfx2/event.hxx>
  47 #include <sfx2/docfile.hxx>
  48 #include <sfx2/docfilt.hxx>
  49
  50 #include "toolkit/awt/vclxdevice.hxx"
  51
  52 #include "view.hrc"
  53 #include "helpid.hrc"
  54
  55 using namespace com::sun::star;
  56 using namespace com::sun::star::uno;
  57
  58 TYPEINIT1(SfxPrintingHint, SfxHint);
  59
  60 // -----------------------------------------------------------------------
  61 class SfxPrinterController : public vcl::PrinterController, public SfxListener
  62 {
  63     Any                                     maCompleteSelection;
  64     Any                                     maSelection;
  65     Reference< view::XRenderable >          mxRenderable;
  66     mutable Printer*                        mpLastPrinter;
  67     mutable Reference<awt::XDevice>         mxDevice;
  68     SfxViewShell*                           mpViewShell;
  69     SfxObjectShell*                         mpObjectShell;
  70     sal_Bool        m_bOrigStatus;
  71     sal_Bool        m_bNeedsChange;
  72     sal_Bool        m_bApi;
  73     sal_Bool        m_bTempPrinter;
  74     util::DateTime  m_aLastPrinted;
  75     OUString m_aLastPrintedBy;
  76
  77     Sequence< beans::PropertyValue > getMergedOptions() const;
  78     const Any& getSelectionObject() const;
  79 public:
  80     SfxPrinterController( const boost::shared_ptr<Printer>& i_rPrinter,
  81                           const Any& i_rComplete,
  82                           const Any& i_rSelection,
  83                           const Any& i_rViewProp,
  84                           const Reference< view::XRenderable >& i_xRender,
  85                           sal_Bool i_bApi, sal_Bool i_bDirect,
  86                           SfxViewShell* pView,
  87                           const uno::Sequence< beans::PropertyValue >& rProps
  88                         );
  89
  90     virtual ~SfxPrinterController();
  91     virtual void Notify( SfxBroadcaster&, const SfxHint& );
  92
  93     virtual int  getPageCount() const;
  94     virtual Sequence< beans::PropertyValue > getPageParameters( int i_nPage ) const;
  95     virtual void printPage( int i_nPage ) const;
  96     virtual void jobStarted();
  97     virtual void jobFinished( com::sun::star::view::PrintableState );
  98 };
  99
 100 SfxPrinterController::SfxPrinterController( const boost::shared_ptr<Printer>& i_rPrinter,
 101                                             const Any& i_rComplete,
 102                                             const Any& i_rSelection,
 103                                             const Any& i_rViewProp,
 104                                             const Reference< view::XRenderable >& i_xRender,
 105                                             sal_Bool i_bApi, sal_Bool i_bDirect,
 106                                             SfxViewShell* pView,
 107                                             const uno::Sequence< beans::PropertyValue >& rProps
 108                                           )
 109     : PrinterController( i_rPrinter)
 110     , maCompleteSelection( i_rComplete )
 111     , maSelection( i_rSelection )
 112     , mxRenderable( i_xRender )
 113     , mpLastPrinter( NULL )
 114     , mpViewShell( pView )
 115     , mpObjectShell(0)
 116     , m_bOrigStatus( sal_False )
 117     , m_bNeedsChange( sal_False )
 118     , m_bApi(i_bApi)
 119     , m_bTempPrinter( i_rPrinter.get() != NULL )
 120 {
 121     if ( mpViewShell )
 122     {
 123         StartListening( *mpViewShell );
 124         mpObjectShell = mpViewShell->GetObjectShell();
 125         StartListening( *mpObjectShell );
 126     }
 127
 128     // initialize extra ui options
 129     if( mxRenderable.is() )
 130     {
 131         for (sal_Int32 nProp=0; nProp < rProps.getLength(); ++nProp)
 132             setValue( rProps[nProp].Name, rProps[nProp].Value );
 133
 134         Sequence< beans::PropertyValue > aRenderOptions( 3 );
 135         aRenderOptions[0].Name = OUString( "ExtraPrintUIOptions"  );
 136         aRenderOptions[1].Name = OUString( "View"  );
 137         aRenderOptions[1].Value = i_rViewProp;
 138         aRenderOptions[2].Name = OUString( "IsPrinter"  );
 139         aRenderOptions[2].Value <<= sal_True;
 140         try
 141         {
 142             Sequence< beans::PropertyValue > aRenderParms( mxRenderable->getRenderer( 0 , getSelectionObject(), aRenderOptions ) );
 143             int nProps = aRenderParms.getLength();
 144             for( int i = 0; i < nProps; i++ )
 145             {
 146                 if ( aRenderParms[i].Name == "ExtraPrintUIOptions" )
 147                 {
 148                     Sequence< beans::PropertyValue > aUIProps;
 149                     aRenderParms[i].Value >>= aUIProps;
 150                     setUIOptions( aUIProps );
 151                 }
 152                 else if( aRenderParms[i].Name == "NUp" )
 153                 {
 154                     setValue( aRenderParms[i].Name, aRenderParms[i].Value );
 155                 }
 156             }
 157         }
 158         catch( lang::IllegalArgumentException& )
 159         {
 160             // the first renderer should always be available for the UI options,
 161             // but catch the exception to be safe
 162         }
 163     }
 164
 165     // set some job parameters
 166     setValue( OUString( "IsApi"  ), makeAny( i_bApi ) );
 167     setValue( OUString( "IsDirect"  ), makeAny( i_bDirect ) );
 168     setValue( OUString( "IsPrinter"  ), makeAny( sal_True ) );
 169     setValue( OUString( "View"  ), i_rViewProp );
 170 }
 171
 172 void SfxPrinterController::Notify( SfxBroadcaster& , const SfxHint& rHint )
 173 {
 174     if ( rHint.IsA(TYPE(SfxSimpleHint)) )
 175     {
 176         if ( ((SfxSimpleHint&)rHint).GetId() == SFX_HINT_DYING )
 177         {
 178             EndListening(*mpViewShell);
 179             EndListening(*mpObjectShell);
 180             mpViewShell = 0;
 181             mpObjectShell = 0;
 182         }
 183     }
 184 }
 185
 186 SfxPrinterController::~SfxPrinterController()
 187 {
 188 }
 189
 190 const Any& SfxPrinterController::getSelectionObject() const
 191 {
 192     const beans::PropertyValue* pVal = getValue( OUString( "PrintSelectionOnly"  ) );
 193     if( pVal )
 194     {
 195         sal_Bool bSel = sal_False;
 196         pVal->Value >>= bSel;
 197         return bSel ? maSelection : maCompleteSelection;
 198     }
 199
 200     sal_Int32 nChoice = 0;
 201     pVal = getValue( OUString( "PrintContent"  ) );
 202     if( pVal )
 203         pVal->Value >>= nChoice;
 204     return (nChoice > 1) ? maSelection : maCompleteSelection;
 205 }
 206
 207 Sequence< beans::PropertyValue > SfxPrinterController::getMergedOptions() const
 208 {
 209     boost::shared_ptr<Printer> pPrinter( getPrinter() );
 210     if( pPrinter.get() != mpLastPrinter )
 211     {
 212         mpLastPrinter = pPrinter.get();
 213         VCLXDevice* pXDevice = new VCLXDevice();
 214         pXDevice->SetOutputDevice( mpLastPrinter );
 215         mxDevice = Reference< awt::XDevice >( pXDevice );
 216     }
 217
 218     Sequence< beans::PropertyValue > aRenderOptions( 1 );
 219     aRenderOptions[ 0 ].Name = OUString( "RenderDevice"  );
 220     aRenderOptions[ 0 ].Value <<= mxDevice;
 221
 222     aRenderOptions = getJobProperties( aRenderOptions );
 223     return aRenderOptions;
 224 }
 225
 226 int SfxPrinterController::getPageCount() const
 227 {
 228     int nPages = 0;
 229     boost::shared_ptr<Printer> pPrinter( getPrinter() );
 230     if( mxRenderable.is() && pPrinter )
 231     {
 232         Sequence< beans::PropertyValue > aJobOptions( getMergedOptions() );
 233         try
 234         {
 235             nPages = mxRenderable->getRendererCount( getSelectionObject(), aJobOptions );
 236         }
 237         catch (lang::DisposedException &)
 238         {
 239             OSL_TRACE("SfxPrinterController: document disposed while printing");
 240             const_cast<SfxPrinterController*>(this)->setJobState(
 241                     view::PrintableState_JOB_ABORTED);
 242         }
 243     }
 244     return nPages;
 245 }
 246
 247 Sequence< beans::PropertyValue > SfxPrinterController::getPageParameters( int i_nPage ) const
 248 {
 249     boost::shared_ptr<Printer> pPrinter( getPrinter() );
 250     Sequence< beans::PropertyValue > aResult;
 251
 252     if( mxRenderable.is() && pPrinter )
 253     {
 254         Sequence< beans::PropertyValue > aJobOptions( getMergedOptions() );
 255         try
 256         {
 257             aResult = mxRenderable->getRenderer( i_nPage, getSelectionObject(), aJobOptions );
 258         }
 259         catch( lang::IllegalArgumentException& )
 260         {
 261         }
 262         catch (lang::DisposedException &)
 263         {
 264             OSL_TRACE("SfxPrinterController: document disposed while printing");
 265             const_cast<SfxPrinterController*>(this)->setJobState(
 266                     view::PrintableState_JOB_ABORTED);
 267         }
 268     }
 269     return aResult;
 270 }
 271
 272 void SfxPrinterController::printPage( int i_nPage ) const
 273 {
 274     boost::shared_ptr<Printer> pPrinter( getPrinter() );
 275     if( mxRenderable.is() && pPrinter )
 276     {
 277         Sequence< beans::PropertyValue > aJobOptions( getMergedOptions() );
 278         try
 279         {
 280             mxRenderable->render( i_nPage, getSelectionObject(), aJobOptions );
 281         }
 282         catch( lang::IllegalArgumentException& )
 283         {
 284             // don't care enough about nonexistant page here
 285             // to provoke a crash
 286         }
 287         catch (lang::DisposedException &)
 288         {
 289             OSL_TRACE("SfxPrinterController: document disposed while printing");
 290             const_cast<SfxPrinterController*>(this)->setJobState(
 291                     view::PrintableState_JOB_ABORTED);
 292         }
 293     }
 294 }
 295
 296 void SfxPrinterController::jobStarted()
 297 {
 298     if ( mpObjectShell )
 299     {
 300         m_bOrigStatus = mpObjectShell->IsEnableSetModified();
 301
 302         // check configuration: shall update of printing information in DocInfo set the document to "modified"?
 303         if ( m_bOrigStatus && !SvtPrintWarningOptions().IsModifyDocumentOnPrintingAllowed() )
 304         {
 305             mpObjectShell->EnableSetModified( sal_False );
 306             m_bNeedsChange = sal_True;
 307         }
 308
 309         // refresh document info
 310         uno::Reference<document::XDocumentProperties> xDocProps(mpObjectShell->getDocProperties());
 311         m_aLastPrintedBy = xDocProps->getPrintedBy();
 312         m_aLastPrinted = xDocProps->getPrintDate();
 313
 314         xDocProps->setPrintedBy( mpObjectShell->IsUseUserData()
 315             ? OUString( SvtUserOptions().GetFullName() )
 316             : OUString() );
 317         ::DateTime now( ::DateTime::SYSTEM );
 318
 319         xDocProps->setPrintDate( util::DateTime(
 320             now.GetNanoSec(), now.GetSec(), now.GetMin(), now.GetHour(),
 321             now.GetDay(), now.GetMonth(), now.GetYear(), false) );
 322
 323         SFX_APP()->NotifyEvent( SfxEventHint(SFX_EVENT_PRINTDOC, GlobalEventConfig::GetEventName( STR_EVENT_PRINTDOC ), mpObjectShell ) );
 324         // FIXME: how to get all print options incl. AdditionalOptions easily?
 325         uno::Sequence < beans::PropertyValue > aOpts;
 326         mpObjectShell->Broadcast( SfxPrintingHint( view::PrintableState_JOB_STARTED, aOpts ) );
 327     }
 328 }
 329
 330 void SfxPrinterController::jobFinished( com::sun::star::view::PrintableState nState )
 331 {
 332     if ( mpObjectShell )
 333     {
 334         bool bCopyJobSetup = false;
 335         mpObjectShell->Broadcast( SfxPrintingHint( nState ) );
 336         switch ( nState )
 337         {
 338             case view::PrintableState_JOB_FAILED :
 339             {
 340                 // "real" problem (not simply printing cancelled by user)
 341                 OUString aMsg( SfxResId(STR_NOSTARTPRINTER).toString() );
 342                 if ( !m_bApi )
 343                     ErrorBox( mpViewShell->GetWindow(), WB_OK | WB_DEF_OK,  aMsg ).Execute();
 344                 // intentionally no break
 345             }
 346             case view::PrintableState_JOB_ABORTED :
 347             {
 348                 // printing not successful, reset DocInfo
 349                 uno::Reference<document::XDocumentProperties> xDocProps(mpObjectShell->getDocProperties());
 350                 xDocProps->setPrintedBy(m_aLastPrintedBy);
 351                 xDocProps->setPrintDate(m_aLastPrinted);
 352                 break;
 353             }
 354
 355             case view::PrintableState_JOB_SPOOLED :
 356             case view::PrintableState_JOB_COMPLETED :
 357             {
 358                 SfxBindings& rBind = mpViewShell->GetViewFrame()->GetBindings();
 359                 rBind.Invalidate( SID_PRINTDOC );
 360                 rBind.Invalidate( SID_PRINTDOCDIRECT );
 361                 rBind.Invalidate( SID_SETUPPRINTER );
 362                 bCopyJobSetup = ! m_bTempPrinter;
 363                 break;
 364             }
 365
 366             default:
 367                 break;
 368         }
 369
 370         if( bCopyJobSetup && mpViewShell )
 371         {
 372             // #i114306#
 373             // Note: this possibly creates a printer that gets immediately replaced
 374             // by a new one. The reason for this is that otherwise we would not get
 375             // the printer's SfxItemSet here to copy. Awkward, but at the moment there is no
 376             // other way here to get the item set.
 377             SfxPrinter* pDocPrt = mpViewShell->GetPrinter(sal_True);
 378             if( pDocPrt )
 379             {
 380                 if( pDocPrt->GetName() == getPrinter()->GetName() )
 381                     pDocPrt->SetJobSetup( getPrinter()->GetJobSetup() );
 382                 else
 383                 {
 384                     SfxPrinter* pNewPrt = new SfxPrinter( pDocPrt->GetOptions().Clone(), getPrinter()->GetName() );
 385                     pNewPrt->SetJobSetup( getPrinter()->GetJobSetup() );
 386                     mpViewShell->SetPrinter( pNewPrt, SFX_PRINTER_PRINTER | SFX_PRINTER_JOBSETUP );
 387                 }
 388             }
 389         }
 390
 391         if ( m_bNeedsChange )
 392             mpObjectShell->EnableSetModified( m_bOrigStatus );
 393
 394         if ( mpViewShell )
 395         {
 396             mpViewShell->pImp->m_pPrinterController.reset();
 397         }
 398     }
 399 }
 400
 401 //====================================================================
 402
 403 class SfxDialogExecutor_Impl
 404
 405 /*  [Description]
 406
 407     An instance of this class is created for the life span of the
 408     printer dialogue, to create in its click handler for the additions by the
 409     virtual method of the derived SfxViewShell generated print options dialogue
 410     and to cache the options set there as SfxItemSet.
 411 */
 412
 413 {
 414 private:
 415     SfxViewShell*           _pViewSh;
 416     PrinterSetupDialog*     _pSetupParent;
 417     SfxItemSet*             _pOptions;
 418     sal_Bool                _bHelpDisabled;
 419
 420     DECL_LINK( Execute, void * );
 421
 422 public:
 423             SfxDialogExecutor_Impl( SfxViewShell* pViewSh, PrinterSetupDialog* pParent );
 424             ~SfxDialogExecutor_Impl() { delete _pOptions; }
 425
 426     Link                GetLink() const { return LINK( this, SfxDialogExecutor_Impl, Execute); }
 427     const SfxItemSet*   GetOptions() const { return _pOptions; }
 428     void                DisableHelp() { _bHelpDisabled = sal_True; }
 429 };
 430
 431 //--------------------------------------------------------------------
 432
 433 SfxDialogExecutor_Impl::SfxDialogExecutor_Impl( SfxViewShell* pViewSh, PrinterSetupDialog* pParent ) :
 434
 435     _pViewSh        ( pViewSh ),
 436     _pSetupParent   ( pParent ),
 437     _pOptions       ( NULL ),
 438     _bHelpDisabled  ( sal_False )
 439
 440 {
 441 }
 442
 443 //--------------------------------------------------------------------
 444
 445 IMPL_LINK_NOARG(SfxDialogExecutor_Impl, Execute)
 446 {
 447     // Options noted locally
 448     if ( !_pOptions )
 449     {
 450         DBG_ASSERT( _pSetupParent, "no dialog parent" );
 451         if( _pSetupParent )
 452             _pOptions = ( (SfxPrinter*)_pSetupParent->GetPrinter() )->GetOptions().Clone();
 453     }
 454
 455     // Create Dialog
 456     SfxPrintOptionsDialog* pDlg = new SfxPrintOptionsDialog( static_cast<Window*>(_pSetupParent),
 457                                                              _pViewSh, _pOptions );
 458     if ( _bHelpDisabled )
 459         pDlg->DisableHelp();
 460     if ( pDlg->Execute() == RET_OK )
 461     {
 462         delete _pOptions;
 463         _pOptions = pDlg->GetOptions().Clone();
 464
 465     }
 466     delete pDlg;
 467
 468     return 0;
 469 }
 470
 471 //-------------------------------------------------------------------------
 472
 473 SfxPrinter* SfxViewShell::SetPrinter_Impl( SfxPrinter *pNewPrinter )
 474
 475
 476 /* Internal method for setting the differences between 'pNewPrinter' to the
 477    current printer. pNewPrinter is either taken over or deleted.
 478 */
 479
 480 {
 481     // get current Printer
 482     SfxPrinter *pDocPrinter = GetPrinter();
 483
 484     // Evaluate Printer Options
 485     bool bOriToDoc = false;
 486     bool bSizeToDoc = false;
 487     if ( &pDocPrinter->GetOptions() )
 488     {
 489         sal_uInt16 nWhich = GetPool().GetWhich(SID_PRINTER_CHANGESTODOC);
 490         const SfxFlagItem *pFlagItem = 0;
 491         pDocPrinter->GetOptions().GetItemState( nWhich, sal_False, (const SfxPoolItem**) &pFlagItem );
 492         bOriToDoc = pFlagItem ? (pFlagItem->GetValue() & SFX_PRINTER_CHG_ORIENTATION) : sal_False;
 493         bSizeToDoc = pFlagItem ? (pFlagItem->GetValue() & SFX_PRINTER_CHG_SIZE) : sal_False;
 494     }
 495
 496     // Determine the previous format and size
 497     Orientation eOldOri = pDocPrinter->GetOrientation();
 498     Size aOldPgSz = pDocPrinter->GetPaperSizePixel();
 499
 500     // Determine the new format and size
 501     Orientation eNewOri = pNewPrinter->GetOrientation();
 502     Size aNewPgSz = pNewPrinter->GetPaperSizePixel();
 503
 504     // Determine the changes in page format
 505     sal_Bool bOriChg = (eOldOri != eNewOri) && bOriToDoc;
 506     sal_Bool bPgSzChg = ( aOldPgSz.Height() !=
 507             ( bOriChg ? aNewPgSz.Width() : aNewPgSz.Height() ) ||
 508             aOldPgSz.Width() !=
 509             ( bOriChg ? aNewPgSz.Height() : aNewPgSz.Width() ) ) &&
 510             bSizeToDoc;
 511
 512     // Message and Flags for page format, summaries changes
 513     OUString aMsg;
 514     sal_uInt16 nNewOpt=0;
 515     if( bOriChg && bPgSzChg )
 516     {
 517         aMsg = SfxResId(STR_PRINT_NEWORISIZE).toString();
 518         nNewOpt = SFX_PRINTER_CHG_ORIENTATION | SFX_PRINTER_CHG_SIZE;
 519     }
 520     else if (bOriChg )
 521     {
 522         aMsg = SfxResId(STR_PRINT_NEWORI).toString();
 523         nNewOpt = SFX_PRINTER_CHG_ORIENTATION;
 524     }
 525     else if (bPgSzChg)
 526     {
 527         aMsg = SfxResId(STR_PRINT_NEWSIZE).toString();
 528         nNewOpt = SFX_PRINTER_CHG_SIZE;
 529     }
 530
 531     // Summaries in this variable what has been changed.
 532     sal_uInt16 nChangedFlags = 0;
 533
 534     // Ask if possible, if page format should be taken over from printer.
 535     if ( ( bOriChg  || bPgSzChg ) &&
 536         RET_YES == QueryBox(0, WB_YES_NO | WB_DEF_OK, aMsg).Execute() )
 537     {
 538         // Flags with changes for  <SetPrinter(SfxPrinter*)> are maintained
 539         nChangedFlags |= nNewOpt;
 540     }
 541
 542     // For the MAC to have its "temporary of class String" in next if()
 543     String aTempPrtName = pNewPrinter->GetName();
 544     String aDocPrtName = pDocPrinter->GetName();
 545
 546     // Was the printer selection changed from Default to Specific
 547     // or the other way around?
 548     if ( (aTempPrtName != aDocPrtName) || (pDocPrinter->IsDefPrinter() != pNewPrinter->IsDefPrinter()) )
 549     {
 550         nChangedFlags |= SFX_PRINTER_PRINTER|SFX_PRINTER_JOBSETUP;
 551         pDocPrinter = pNewPrinter;
 552     }
 553     else
 554     {
 555         // Compare extra options
 556         if ( ! (pNewPrinter->GetOptions() == pDocPrinter->GetOptions()) )
 557         {
 558             // Option have changed
 559             pDocPrinter->SetOptions( pNewPrinter->GetOptions() );
 560             nChangedFlags |= SFX_PRINTER_OPTIONS;
 561         }
 562
 563         // Compare JobSetups
 564         JobSetup aNewJobSetup = pNewPrinter->GetJobSetup();
 565         JobSetup aOldJobSetup = pDocPrinter->GetJobSetup();
 566         if ( aNewJobSetup != aOldJobSetup )
 567         {
 568             nChangedFlags |= SFX_PRINTER_JOBSETUP;
 569         }
 570
 571         // Keep old changed Printer.
 572         pDocPrinter->SetPrinterProps( pNewPrinter );
 573         delete pNewPrinter;
 574     }
 575
 576     if ( 0 != nChangedFlags )
 577         // SetPrinter will delete the old printer if it changes
 578         SetPrinter( pDocPrinter, nChangedFlags );
 579     return pDocPrinter;
 580 }
 581
 582 void SfxViewShell::ExecPrint( const uno::Sequence < beans::PropertyValue >& rProps, sal_Bool bIsAPI, sal_Bool bIsDirect )
 583 {
 584     // get the current selection; our controller should know it
 585     Reference< frame::XController > xController( GetController() );
 586     Reference< view::XSelectionSupplier > xSupplier( xController, UNO_QUERY );
 587
 588     Any aSelection;
 589     if( xSupplier.is() )
 590         aSelection = xSupplier->getSelection();
 591     else
 592         aSelection <<= GetObjectShell()->GetModel();
 593     Any aComplete( makeAny( GetObjectShell()->GetModel() ) );
 594     Any aViewProp( makeAny( xController ) );
 595     boost::shared_ptr<Printer> aPrt;
 596
 597     const beans::PropertyValue* pVal = rProps.getConstArray();
 598     for( sal_Int32 i = 0; i < rProps.getLength(); i++ )
 599     {
 600         if ( pVal[i].Name == "PrinterName" )
 601         {
 602             OUString aPrinterName;
 603             pVal[i].Value >>= aPrinterName;
 604             aPrt.reset( new Printer( aPrinterName ) );
 605             break;
 606         }
 607     }
 608
 609     boost::shared_ptr<vcl::PrinterController> pController( new SfxPrinterController(
 610                                                                                aPrt,
 611                                                                                aComplete,
 612                                                                                aSelection,
 613                                                                                aViewProp,
 614                                                                                GetRenderable(),
 615                                                                                bIsAPI,
 616                                                                                bIsDirect,
 617                                                                                this,
 618                                                                                rProps
 619                                                                                ) );
 620     pImp->m_pPrinterController = pController;
 621
 622     SfxObjectShell *pObjShell = GetObjectShell();
 623     pController->setValue( OUString( "JobName"  ),
 624                         makeAny( OUString( pObjShell->GetTitle(0) ) ) );
 625
 626     // FIXME: job setup
 627     SfxPrinter* pDocPrt = GetPrinter(sal_False);
 628     JobSetup aJobSetup = pDocPrt ? pDocPrt->GetJobSetup() : GetJobSetup();
 629     if( bIsDirect )
 630         aJobSetup.SetValue( String( "IsQuickJob"  ),
 631                             String( "true"  ) );
 632
 633     Printer::PrintJob( pController, aJobSetup );
 634 }
 635
 636 Printer* SfxViewShell::GetActivePrinter() const
 637 {
 638     return (pImp->m_pPrinterController)
 639         ?  pImp->m_pPrinterController->getPrinter().get() : 0;
 640 }
 641
 642 void SfxViewShell::ExecPrint_Impl( SfxRequest &rReq )
 643 {
 644     sal_uInt16              nDialogRet = RET_CANCEL;
 645     SfxPrinter*             pPrinter = 0;
 646     SfxDialogExecutor_Impl* pExecutor = 0;
 647     bool                    bSilent = false;
 648
 649     // does the function have been called by the user interface or by an API call
 650     sal_Bool bIsAPI = rReq.GetArgs() && rReq.GetArgs()->Count();
 651     if ( bIsAPI )
 652     {
 653         // the function have been called by the API
 654
 655         // Should it be visible on the user interface,
 656         // should it launch popup dialogue ?
 657         SFX_REQUEST_ARG(rReq, pSilentItem, SfxBoolItem, SID_SILENT, sal_False);
 658         bSilent = pSilentItem && pSilentItem->GetValue();
 659     }
 660
 661     // no help button in dialogs if called from the help window
 662     // (pressing help button would exchange the current page inside the help
 663     // document that is going to be printed!)
 664     String aHelpFilterName( "writer_web_HTML_help" );
 665     SfxMedium* pMedium = GetViewFrame()->GetObjectShell()->GetMedium();
 666     const SfxFilter* pFilter = pMedium ? pMedium->GetFilter() : NULL;
 667     sal_Bool bPrintOnHelp = ( pFilter && pFilter->GetFilterName() == aHelpFilterName );
 668
 669     const sal_uInt16 nId = rReq.GetSlot();
 670     switch( nId )
 671     {
 672         case SID_PRINTDOC: // display the printer selection and properties dialogue : File > Print…
 673         case SID_PRINTDOCDIRECT: // Print the document directly, without displaying the dialogue
 674         {
 675             SfxObjectShell* pDoc = GetObjectShell();
 676
 677             // derived class may decide to abort this
 678             if( pDoc == NULL || !pDoc->QuerySlotExecutable( nId ) )
 679             {
 680                 rReq.SetReturnValue( SfxBoolItem( 0, sal_False ) );
 681                 return;
 682             }
 683
 684             if ( !bSilent && pDoc->QueryHiddenInformation( WhenPrinting, NULL ) != RET_YES )
 685                 return;
 686
 687             // should we print only the selection or the whole document
 688             SFX_REQUEST_ARG(rReq, pSelectItem, SfxBoolItem, SID_SELECTION, sal_False);
 689             sal_Bool bSelection = ( pSelectItem != NULL && pSelectItem->GetValue() );
 690             // detect non api call from writer ( that adds SID_SELECTION ) and reset bIsAPI
 691             if ( pSelectItem && rReq.GetArgs()->Count() == 1 )
 692                 bIsAPI = sal_False;
 693
 694             uno::Sequence < beans::PropertyValue > aProps;
 695             if ( bIsAPI )
 696             {
 697                 // supported properties:
 698                 // String PrinterName
 699                 // String FileName
 700                 // Int16 From
 701                 // Int16 To
 702                 // In16 Copies
 703                 // String RangeText
 704                 // bool Selection
 705                 // bool Asynchron
 706                 // bool Collate
 707                 // bool Silent
 708
 709                 // the TransformItems function overwrite aProps
 710                 TransformItems( nId, *rReq.GetArgs(), aProps, GetInterface()->GetSlot(nId) );
 711
 712                 for ( sal_Int32 nProp=0; nProp < aProps.getLength(); ++nProp )
 713                 {
 714                     if ( aProps[nProp].Name == "Copies" )
 715                     {
 716                         aProps[nProp]. Name = OUString("CopyCount");
 717                     }
 718                     else if ( aProps[nProp].Name == "RangeText" )
 719                     {
 720                         aProps[nProp]. Name = OUString("Pages");
 721                     }
 722                     else if ( aProps[nProp].Name == "Asynchron" )
 723                     {
 724                         aProps[nProp]. Name = OUString("Wait");
 725                         sal_Bool bAsynchron = sal_False;
 726                         aProps[nProp].Value >>= bAsynchron;
 727                         aProps[nProp].Value <<= (sal_Bool) (!bAsynchron);
 728                     }
 729                     else if ( aProps[nProp].Name == "Silent" )
 730                     {
 731                         aProps[nProp]. Name = OUString("MonitorVisible");
 732                         sal_Bool bPrintSilent = sal_False;
 733                         aProps[nProp].Value >>= bPrintSilent;
 734                         aProps[nProp].Value <<= (sal_Bool) (!bPrintSilent);
 735                     }
 736                 }
 737             }
 738
 739             // we will add the "PrintSelectionOnly" or "HideHelpButton" properties
 740             // we have to increase the capacity of aProps
 741             sal_Int32 nLen = aProps.getLength();
 742             aProps.realloc( nLen + 1 );
 743
 744             // HACK: writer sets the SID_SELECTION item when printing directly and expects
 745             // to get only the selection document in that case (see getSelectionObject)
 746             // however it also reacts to the PrintContent property. We need this distinction here, too,
 747             // else one of the combinations print / print direct and selection / all will not work.
 748             // it would be better if writer handled this internally
 749             if( nId == SID_PRINTDOCDIRECT )
 750             {
 751                 aProps[nLen].Name = OUString( "PrintSelectionOnly"  );
 752                 aProps[nLen].Value = makeAny( bSelection );
 753             }
 754             else // if nId == SID_PRINTDOC ; nothing to do with the previous HACK
 755             {
 756                 // should the printer selection and properties dialogue display an help button
 757                 aProps[nLen].Name = OUString( "HideHelpButton" );
 758                 aProps[nLen].Value = makeAny( bPrintOnHelp );
 759             }
 760
 761             ExecPrint( aProps, bIsAPI, (nId == SID_PRINTDOCDIRECT) );
 762
 763             // FIXME: Recording
 764             rReq.Done();
 765             break;
 766         }
 767         case SID_SETUPPRINTER : // display the printer settings dialogue : File > Printer Settings…
 768         case SID_PRINTER_NAME : // only for recorded macros
 769         {
 770             // get printer and printer settings from the document
 771             SfxPrinter *pDocPrinter = GetPrinter(sal_True);
 772
 773             // look for printer in parameters
 774             SFX_REQUEST_ARG( rReq, pPrinterItem, SfxStringItem, SID_PRINTER_NAME, sal_False );
 775             if ( pPrinterItem )
 776             {
 777                 // use PrinterName parameter to create a printer
 778                 pPrinter = new SfxPrinter( pDocPrinter->GetOptions().Clone(), ((const SfxStringItem*) pPrinterItem)->GetValue() );
 779
 780                 // if printer is unknown, it can't be used - now printer from document will be used
 781                 if ( !pPrinter->IsKnown() )
 782                     DELETEZ(pPrinter);
 783             }
 784
 785             if ( SID_PRINTER_NAME == nId )
 786             {
 787                 // just set a recorded printer name
 788                 if ( pPrinter )
 789                     SetPrinter( pPrinter, SFX_PRINTER_PRINTER  );
 790                 return;
 791             }
 792
 793             // no PrinterName parameter in ItemSet or the PrinterName points to an unknown printer
 794             if ( !pPrinter )
 795                 // use default printer from document
 796                 pPrinter = pDocPrinter;
 797
 798             if( !pPrinter || !pPrinter->IsValid() )
 799             {
 800                 // no valid printer either in ItemSet or at the document
 801                 if ( !bSilent )
 802                     ErrorBox( NULL, WB_OK | WB_DEF_OK, SfxResId(STR_NODEFPRINTER).toString() ).Execute();
 803
 804                 rReq.SetReturnValue(SfxBoolItem(0,sal_False));
 805
 806                 break;
 807             }
 808
 809             // FIXME: printer isn't used for printing anymore!
 810             if( pPrinter->IsPrinting() )
 811             {
 812                 // if printer is busy, abort configuration
 813                 if ( !bSilent )
 814                     InfoBox( NULL, SfxResId(STR_ERROR_PRINTER_BUSY).toString() ).Execute();
 815                 rReq.SetReturnValue(SfxBoolItem(0,sal_False));
 816
 817                 return;
 818             }
 819
 820             // if no arguments are given, retrieve them from a dialog
 821             if ( !bIsAPI )
 822             {
 823                 // PrinterDialog needs a temporary printer
 824                 SfxPrinter* pDlgPrinter = pPrinter->Clone();
 825                 nDialogRet = 0;
 826
 827                 // execute PrinterSetupDialog
 828                 PrinterSetupDialog* pPrintSetupDlg = new PrinterSetupDialog( GetWindow() );
 829
 830                 if (pImp->m_bHasPrintOptions && HasPrintOptionsPage())
 831                 {
 832                     // additional controls for dialog
 833                     pExecutor = new SfxDialogExecutor_Impl( this, pPrintSetupDlg );
 834                     if ( bPrintOnHelp )
 835                         pExecutor->DisableHelp();
 836                     pPrintSetupDlg->SetOptionsHdl( pExecutor->GetLink() );
 837                 }
 838
 839                 pPrintSetupDlg->SetPrinter( pDlgPrinter );
 840                 nDialogRet = pPrintSetupDlg->Execute();
 841
 842                 if ( pExecutor && pExecutor->GetOptions() )
 843                 {
 844                     if ( nDialogRet == RET_OK )
 845                         // remark: have to be recorded if possible!
 846                         pDlgPrinter->SetOptions( *pExecutor->GetOptions() );
 847                     else
 848                     {
 849                         pPrinter->SetOptions( *pExecutor->GetOptions() );
 850                         SetPrinter( pPrinter, SFX_PRINTER_OPTIONS );
 851                     }
 852                 }
 853
 854                 DELETEZ( pPrintSetupDlg );
 855
 856                 // no recording of PrinterSetup except printer name (is printer dependent)
 857                 rReq.Ignore();
 858
 859                 if ( nDialogRet == RET_OK )
 860                 {
 861                     if ( pPrinter->GetName() != pDlgPrinter->GetName() )
 862                     {
 863                         // user has changed the printer -> macro recording
 864                         SfxRequest aReq( GetViewFrame(), SID_PRINTER_NAME );
 865                         aReq.AppendItem( SfxStringItem( SID_PRINTER_NAME, pDlgPrinter->GetName() ) );
 866                         aReq.Done();
 867                     }
 868
 869                     // take the changes made in the dialog
 870                     pPrinter = SetPrinter_Impl( pDlgPrinter );
 871
 872                     // forget new printer, it was taken over (as pPrinter) or deleted
 873                     pDlgPrinter = NULL;
 874
 875                 }
 876                 else
 877                 {
 878                     // PrinterDialog is used to transfer information on printing,
 879                     // so it will only be deleted here if dialog was cancelled
 880                     DELETEZ( pDlgPrinter );
 881                     rReq.Ignore();
 882                     if ( SID_PRINTDOC == nId )
 883                         rReq.SetReturnValue(SfxBoolItem(0,sal_False));
 884                 }
 885             }
 886         }
 887     }
 888 }
 889
 890 //--------------------------------------------------------------------
 891
 892 SfxPrinter* SfxViewShell::GetPrinter( sal_Bool /*bCreate*/ )
 893 {
 894     return 0;
 895 }
 896
 897 //--------------------------------------------------------------------
 898
 899 sal_uInt16 SfxViewShell::SetPrinter( SfxPrinter* /*pNewPrinter*/, sal_uInt16 /*nDiffFlags*/, bool )
 900 {
 901     return 0;
 902 }
 903
 904 //--------------------------------------------------------------------
 905
 906 SfxTabPage* SfxViewShell::CreatePrintOptionsPage
 907 (
 908     Window*             /*pParent*/,
 909     const SfxItemSet&   /*rOptions*/
 910 )
 911 {
 912     return 0;
 913 }
 914
 915 bool SfxViewShell::HasPrintOptionsPage() const
 916 {
 917     return false;
 918 }
 919
 920 JobSetup SfxViewShell::GetJobSetup() const
 921 {
 922     return JobSetup();
 923 }
 924
 925 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */