src/mac/carbon/printmac.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/mac/carbon/printwin.cpp
   3 // Purpose:     wxMacPrinter framework
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #if wxUSE_PRINTING_ARCHITECTURE
  16
  17 #ifdef __BORLANDC__
  18     #pragma hdrstop
  19 #endif
  20
  21 #ifndef WX_PRECOMP
  22     #include "wx/utils.h"
  23     #include "wx/dc.h"
  24     #include "wx/app.h"
  25     #include "wx/msgdlg.h"
  26     #include "wx/dcprint.h"
  27     #include "wx/math.h"
  28 #endif
  29
  30 #include "wx/mac/uma.h"
  31
  32 #include "wx/mac/printmac.h"
  33 #include "wx/mac/private/print.h"
  34
  35 #include "wx/printdlg.h"
  36 #include "wx/mac/printdlg.h"
  37
  38 #include <stdlib.h>
  39
  40 IMPLEMENT_DYNAMIC_CLASS(wxMacCarbonPrintData, wxPrintNativeDataBase)
  41 IMPLEMENT_DYNAMIC_CLASS(wxMacPrinter, wxPrinterBase)
  42 IMPLEMENT_CLASS(wxMacPrintPreview, wxPrintPreviewBase)
  43
  44 bool wxMacCarbonPrintData::IsOk() const
  45 {
  46     return (m_macPageFormat != kPMNoPageFormat) && (m_macPrintSettings != kPMNoPrintSettings) && (m_macPrintSession != kPMNoReference);
  47 }
  48 wxMacCarbonPrintData::wxMacCarbonPrintData()
  49 {
  50     m_macPageFormat = kPMNoPageFormat;
  51     m_macPrintSettings = kPMNoPrintSettings;
  52     m_macPrintSession = kPMNoReference ;
  53     ValidateOrCreate() ;
  54 }
  55
  56 wxMacCarbonPrintData::~wxMacCarbonPrintData()
  57 {
  58     if (m_macPageFormat != kPMNoPageFormat)
  59     {
  60         (void)PMRelease(m_macPageFormat);
  61         m_macPageFormat = kPMNoPageFormat;
  62     }
  63
  64     if (m_macPrintSettings != kPMNoPrintSettings)
  65     {
  66         (void)PMRelease(m_macPrintSettings);
  67         m_macPrintSettings = kPMNoPrintSettings;
  68     }
  69
  70     if ( m_macPrintSession != kPMNoReference )
  71     {
  72         (void)PMRelease(m_macPrintSession);
  73         m_macPrintSession = kPMNoReference;
  74     }
  75 }
  76
  77 void wxMacCarbonPrintData::ValidateOrCreate()
  78 {
  79     OSStatus err = noErr ;
  80     if ( m_macPrintSession == kPMNoReference )
  81     {
  82         err = PMCreateSession( (PMPrintSession *) &m_macPrintSession ) ;
  83     }
  84     //  Set up a valid PageFormat object.
  85     if ( m_macPageFormat == kPMNoPageFormat)
  86     {
  87         err = PMCreatePageFormat((PMPageFormat *) &m_macPageFormat);
  88
  89         //  Note that PMPageFormat is not session-specific, but calling
  90         //  PMSessionDefaultPageFormat assigns values specific to the printer
  91         //  associated with the current printing session.
  92         if ((err == noErr) &&
  93             ( m_macPageFormat != kPMNoPageFormat))
  94         {
  95             err = PMSessionDefaultPageFormat((PMPrintSession) m_macPrintSession,
  96                 (PMPageFormat) m_macPageFormat);
  97         }
  98     }
  99     else
 100     {
 101         err = PMSessionValidatePageFormat((PMPrintSession) m_macPrintSession,
 102             (PMPageFormat) m_macPageFormat,
 103             kPMDontWantBoolean);
 104     }
 105
 106     //  Set up a valid PrintSettings object.
 107     if ( m_macPrintSettings == kPMNoPrintSettings)
 108     {
 109         err = PMCreatePrintSettings((PMPrintSettings *) &m_macPrintSettings);
 110
 111         //  Note that PMPrintSettings is not session-specific, but calling
 112         //  PMSessionDefaultPrintSettings assigns values specific to the printer
 113         //  associated with the current printing session.
 114         if ((err == noErr) &&
 115             ( m_macPrintSettings != kPMNoPrintSettings))
 116         {
 117             err = PMSessionDefaultPrintSettings((PMPrintSession) m_macPrintSession,
 118                 (PMPrintSettings) m_macPrintSettings);
 119         }
 120     }
 121     else
 122     {
 123         err = PMSessionValidatePrintSettings((PMPrintSession) m_macPrintSession,
 124             (PMPrintSettings) m_macPrintSettings,
 125             kPMDontWantBoolean);
 126     }
 127 }
 128
 129 bool wxMacCarbonPrintData::TransferFrom( const wxPrintData &data )
 130 {
 131     ValidateOrCreate() ;
 132     PMSetCopies( (PMPrintSettings) m_macPrintSettings , data.GetNoCopies() , false ) ;
 133     PMSetOrientation( (PMPageFormat) m_macPageFormat , ( data.GetOrientation() == wxLANDSCAPE ) ?
 134         kPMLandscape : kPMPortrait , false ) ;
 135     // collate cannot be set
 136 #if 0 // not yet tested
 137     if ( !m_printerName.empty() )
 138         PMSessionSetCurrentPrinter( (PMPrintSession) m_macPrintSession , wxMacCFStringHolder( m_printerName , wxFont::GetDefaultEncoding() ) ) ;
 139 #endif
 140 #ifndef __LP64__
 141     PMColorMode color ;
 142     PMGetColorMode(  (PMPrintSettings) m_macPrintSettings, &color ) ;
 143     if ( data.GetColour() )
 144     {
 145         if ( color == kPMBlackAndWhite )
 146             PMSetColorMode( (PMPrintSettings) m_macPrintSettings, kPMColor ) ;
 147     }
 148     else
 149         PMSetColorMode( (PMPrintSettings) m_macPrintSettings, kPMBlackAndWhite ) ;
 150 #endif
 151
 152     // PMDuplexMode not yet accessible via API
 153     // PMQualityMode not yet accessible via API
 154     // todo paperSize
 155
 156     PMResolution res;
 157     PMPrinter printer;
 158     PMSessionGetCurrentPrinter(m_macPrintSession, &printer);
 159 #if MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_5
 160     PMPrinterGetOutputResolution( printer,
 161         (PMPrintSettings) m_macPrintSettings,  &res) ;
 162     // TODO transfer ? into page format ?
 163 #else
 164     PMTag tag = kPMMaxSquareResolution;
 165     PMPrinterGetPrinterResolution(printer, tag, &res);
 166     PMSetResolution((PMPageFormat) m_macPageFormat, &res);
 167 #endif
 168     // after setting the new resolution the format has to be updated, otherwise the page rect remains
 169     // at the 'old' scaling
 170     PMSessionValidatePageFormat((PMPrintSession) m_macPrintSession,
 171             (PMPageFormat) m_macPageFormat,
 172             kPMDontWantBoolean) ;
 173
 174     return true ;
 175 }
 176
 177 bool wxMacCarbonPrintData::TransferTo( wxPrintData &data )
 178 {
 179     OSStatus err = noErr ;
 180
 181     UInt32 copies ;
 182     err = PMGetCopies( m_macPrintSettings , &copies ) ;
 183     if ( err == noErr )
 184         data.SetNoCopies( copies ) ;
 185
 186     PMOrientation orientation ;
 187     err = PMGetOrientation(  m_macPageFormat , &orientation ) ;
 188     if ( err == noErr )
 189     {
 190         if ( orientation == kPMPortrait || orientation == kPMReversePortrait )
 191             data.SetOrientation( wxPORTRAIT  );
 192         else
 193             data.SetOrientation( wxLANDSCAPE );
 194     }
 195
 196     // collate cannot be set
 197 #if 0
 198     {
 199         wxMacCFStringHolder name ;
 200         PMPrinter printer ;
 201         PMSessionGetCurrentPrinter( m_macPrintSession ,
 202             &printer ) ;
 203         m_printerName = name.AsString() ;
 204     }
 205 #endif
 206
 207 #ifndef __LP64__
 208     PMColorMode color ;
 209     err = PMGetColorMode( m_macPrintSettings, &color ) ;
 210     if ( err == noErr )
 211         data.SetColour( !(color == kPMBlackAndWhite) ) ;
 212 #endif
 213     // PMDuplexMode not yet accessible via API
 214     // PMQualityMode not yet accessible via API
 215     // todo paperSize
 216     PMRect rPaper;
 217     err = PMGetUnadjustedPaperRect( m_macPageFormat, &rPaper);
 218     if ( err == noErr )
 219     {
 220         data.SetPaperSize( wxSize (
 221             (int)(( rPaper.right - rPaper.left ) * pt2mm + 0.5 ) ,
 222              (int)(( rPaper.bottom - rPaper.top ) * pt2mm + 0.5 ) ) );
 223     }
 224     return true ;
 225 }
 226
 227 void wxMacCarbonPrintData::TransferFrom( wxPageSetupData *data )
 228 {
 229     // should we setup the page rect here ?
 230     // since MacOS sometimes has two same paper rects with different
 231     // page rects we could make it roundtrip safe perhaps
 232 }
 233
 234 void wxMacCarbonPrintData::TransferTo( wxPageSetupData* data )
 235 {
 236     PMRect rPaper;
 237     OSStatus err = PMGetUnadjustedPaperRect(m_macPageFormat, &rPaper);
 238     if ( err == noErr )
 239     {
 240         PMRect rPage ;
 241         err = PMGetUnadjustedPageRect(m_macPageFormat , &rPage ) ;
 242         if ( err == noErr )
 243         {
 244             data->SetMinMarginTopLeft( wxPoint (
 245                 (int)(((double) rPage.left - rPaper.left ) * pt2mm) ,
 246                 (int)(((double) rPage.top - rPaper.top ) * pt2mm) ) ) ;
 247
 248             data->SetMinMarginBottomRight( wxPoint (
 249                 (wxCoord)(((double) rPaper.right - rPage.right ) * pt2mm),
 250                 (wxCoord)(((double) rPaper.bottom - rPage.bottom ) * pt2mm)) ) ;
 251
 252             if ( data->GetMarginTopLeft().x < data->GetMinMarginTopLeft().x )
 253                 data->SetMarginTopLeft( wxPoint( data->GetMinMarginTopLeft().x ,
 254                     data->GetMarginTopLeft().y ) ) ;
 255
 256             if ( data->GetMarginBottomRight().x < data->GetMinMarginBottomRight().x )
 257                 data->SetMarginBottomRight( wxPoint( data->GetMinMarginBottomRight().x ,
 258                     data->GetMarginBottomRight().y ) );
 259
 260             if ( data->GetMarginTopLeft().y < data->GetMinMarginTopLeft().y )
 261                 data->SetMarginTopLeft( wxPoint( data->GetMarginTopLeft().x , data->GetMinMarginTopLeft().y ) );
 262
 263             if ( data->GetMarginBottomRight().y < data->GetMinMarginBottomRight().y )
 264                 data->SetMarginBottomRight( wxPoint( data->GetMarginBottomRight().x ,
 265                     data->GetMinMarginBottomRight().y) );
 266         }
 267     }
 268 }
 269
 270 void wxMacCarbonPrintData::TransferTo( wxPrintDialogData* data )
 271 {
 272     UInt32 minPage , maxPage ;
 273     PMGetPageRange( m_macPrintSettings , &minPage , &maxPage ) ;
 274     data->SetMinPage( minPage ) ;
 275     data->SetMaxPage( maxPage ) ;
 276     UInt32 copies ;
 277     PMGetCopies( m_macPrintSettings , &copies ) ;
 278     data->SetNoCopies( copies ) ;
 279     UInt32 from , to ;
 280     PMGetFirstPage( m_macPrintSettings , &from ) ;
 281     PMGetLastPage( m_macPrintSettings , &to ) ;
 282     if ( to >= 0x7FFFFFFF ) //  due to an OS Bug we don't get back kPMPrintAllPages
 283     {
 284         data->SetAllPages( true ) ;
 285         // This means all pages, more or less
 286         data->SetFromPage(1);
 287         data->SetToPage(32000);
 288     }
 289     else
 290     {
 291         data->SetFromPage( from ) ;
 292         data->SetToPage( to ) ;
 293         data->SetAllPages( false );
 294     }
 295 }
 296
 297 void wxMacCarbonPrintData::TransferFrom( wxPrintDialogData* data )
 298 {
 299     PMSetPageRange( m_macPrintSettings , data->GetMinPage() , data->GetMaxPage() ) ;
 300     PMSetCopies( m_macPrintSettings , data->GetNoCopies() , false ) ;
 301     PMSetFirstPage( m_macPrintSettings , data->GetFromPage() , false ) ;
 302
 303     if (data->GetAllPages() || data->GetFromPage() == 0)
 304         PMSetLastPage( m_macPrintSettings , (UInt32) kPMPrintAllPages, true ) ;
 305     else
 306         PMSetLastPage( m_macPrintSettings , (UInt32) data->GetToPage() , false ) ;
 307 }
 308
 309 /*
 310 * Printer
 311 */
 312
 313 wxMacPrinter::wxMacPrinter(wxPrintDialogData *data):
 314 wxPrinterBase(data)
 315 {
 316 }
 317
 318 wxMacPrinter::~wxMacPrinter(void)
 319 {
 320 }
 321
 322 bool wxMacPrinter::Print(wxWindow *parent, wxPrintout *printout, bool prompt)
 323 {
 324     sm_abortIt = false;
 325     sm_abortWindow = NULL;
 326
 327     if (!printout)
 328         return false;
 329
 330     printout->SetIsPreview(false);
 331     if (m_printDialogData.GetMinPage() < 1)
 332         m_printDialogData.SetMinPage(1);
 333     if (m_printDialogData.GetMaxPage() < 1)
 334         m_printDialogData.SetMaxPage(9999);
 335
 336     // Create a suitable device context
 337     wxPrinterDC *dc = NULL;
 338     if (prompt)
 339     {
 340         wxMacPrintDialog dialog(parent, & m_printDialogData);
 341         if (dialog.ShowModal() == wxID_OK)
 342         {
 343             dc = wxDynamicCast(dialog.GetPrintDC(), wxPrinterDC);
 344             wxASSERT(dc);
 345             m_printDialogData = dialog.GetPrintDialogData();
 346         }
 347     }
 348     else
 349     {
 350         dc = new wxPrinterDC( m_printDialogData.GetPrintData() ) ;
 351     }
 352
 353     // May have pressed cancel.
 354     if (!dc || !dc->Ok())
 355     {
 356         if (dc)
 357             delete dc;
 358         return false;
 359     }
 360
 361     // on the mac we have always pixels as addressing mode with 72 dpi
 362     printout->SetPPIScreen(72, 72);
 363     PMResolution res;
 364     wxMacCarbonPrintData* nativeData = (wxMacCarbonPrintData*)
 365           (m_printDialogData.GetPrintData().GetNativeData());
 366 #if MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_5
 367     PMPrinter printer;
 368     PMSessionGetCurrentPrinter(nativeData->m_macPrintSession, &printer);
 369     PMPrinterGetOutputResolution( printer, nativeData->m_macPrintSettings, &res) ;
 370 #else
 371     PMGetResolution((PMPageFormat) (nativeData->m_macPageFormat), &res);
 372 #endif
 373     printout->SetPPIPrinter(int(res.hRes), int(res.vRes));
 374
 375     // Set printout parameters
 376     printout->SetDC(dc);
 377
 378     int w, h;
 379     dc->GetSize(&w, &h);
 380     printout->SetPageSizePixels((int)w, (int)h);
 381     printout->SetPaperRectPixels(dc->GetPaperRect());
 382     wxCoord mw, mh;
 383     dc->GetSizeMM(&mw, &mh);
 384     printout->SetPageSizeMM((int)mw, (int)mh);
 385
 386     // Create an abort window
 387     wxBeginBusyCursor();
 388
 389     printout->OnPreparePrinting();
 390
 391     // Get some parameters from the printout, if defined
 392     int fromPage, toPage;
 393     int minPage, maxPage;
 394     printout->GetPageInfo(&minPage, &maxPage, &fromPage, &toPage);
 395
 396     if (maxPage == 0)
 397     {
 398         wxEndBusyCursor();
 399         return false;
 400     }
 401
 402     // Only set min and max, because from and to have been
 403     // set by the user
 404     m_printDialogData.SetMinPage(minPage);
 405     m_printDialogData.SetMaxPage(maxPage);
 406
 407     wxWindow *win = CreateAbortWindow(parent, printout);
 408     wxSafeYield(win,true);
 409
 410     if (!win)
 411     {
 412         wxEndBusyCursor();
 413         wxMessageBox(wxT("Sorry, could not create an abort dialog."), wxT("Print Error"), wxOK, parent);
 414         delete dc;
 415
 416         return false;
 417     }
 418
 419     sm_abortWindow = win;
 420     sm_abortWindow->Show(true);
 421     wxSafeYield(win,true);
 422
 423     printout->OnBeginPrinting();
 424
 425     bool keepGoing = true;
 426
 427     int copyCount;
 428     for (copyCount = 1; copyCount <= m_printDialogData.GetNoCopies(); copyCount ++)
 429     {
 430         if (!printout->OnBeginDocument(m_printDialogData.GetFromPage(), m_printDialogData.GetToPage()))
 431         {
 432             wxEndBusyCursor();
 433             wxMessageBox(wxT("Could not start printing."), wxT("Print Error"), wxOK, parent);
 434             break;
 435         }
 436         if (sm_abortIt)
 437             break;
 438
 439         int pn;
 440         for (pn = m_printDialogData.GetFromPage();
 441         keepGoing && (pn <= m_printDialogData.GetToPage()) && printout->HasPage(pn);
 442         pn++)
 443         {
 444             if (sm_abortIt)
 445             {
 446                 keepGoing = false;
 447                 break;
 448             }
 449             else
 450             {
 451 #if TARGET_CARBON
 452                 if ( UMAGetSystemVersion() >= 0x1000 )
 453 #endif
 454                 {
 455 #if !wxMAC_USE_CORE_GRAPHICS
 456                     GrafPtr thePort ;
 457                     GetPort( &thePort ) ;
 458 #endif
 459                     wxSafeYield(win,true);
 460 #if !wxMAC_USE_CORE_GRAPHICS
 461                     SetPort( thePort ) ;
 462 #endif
 463                 }
 464                 dc->StartPage();
 465                 keepGoing = printout->OnPrintPage(pn);
 466                 dc->EndPage();
 467             }
 468         }
 469         printout->OnEndDocument();
 470     }
 471
 472     printout->OnEndPrinting();
 473
 474     if (sm_abortWindow)
 475     {
 476         sm_abortWindow->Show(false);
 477         delete sm_abortWindow;
 478         sm_abortWindow = NULL;
 479     }
 480
 481     wxEndBusyCursor();
 482
 483     delete dc;
 484
 485     return true;
 486 }
 487
 488 wxDC* wxMacPrinter::PrintDialog(wxWindow *parent)
 489 {
 490     wxDC* dc = (wxDC*) NULL;
 491
 492     wxPrintDialog dialog(parent, & m_printDialogData);
 493     int ret = dialog.ShowModal();
 494
 495     if (ret == wxID_OK)
 496     {
 497         dc = dialog.GetPrintDC();
 498         m_printDialogData = dialog.GetPrintDialogData();
 499     }
 500
 501     return dc;
 502 }
 503
 504 bool wxMacPrinter::Setup(wxWindow *parent)
 505 {
 506 #if 0
 507     wxPrintDialog dialog(parent, & m_printDialogData);
 508     dialog.GetPrintDialogData().SetSetupDialog(true);
 509
 510     int ret = dialog.ShowModal();
 511
 512     if (ret == wxID_OK)
 513         m_printDialogData = dialog.GetPrintDialogData();
 514
 515     return (ret == wxID_OK);
 516 #endif
 517
 518     return wxID_CANCEL;
 519 }
 520
 521 /*
 522 * Print preview
 523 */
 524
 525 wxMacPrintPreview::wxMacPrintPreview(wxPrintout *printout,
 526                                      wxPrintout *printoutForPrinting,
 527                                      wxPrintDialogData *data)
 528                                      : wxPrintPreviewBase(printout, printoutForPrinting, data)
 529 {
 530     DetermineScaling();
 531 }
 532
 533 wxMacPrintPreview::wxMacPrintPreview(wxPrintout *printout, wxPrintout *printoutForPrinting, wxPrintData *data):
 534 wxPrintPreviewBase(printout, printoutForPrinting, data)
 535 {
 536     DetermineScaling();
 537 }
 538
 539 wxMacPrintPreview::~wxMacPrintPreview(void)
 540 {
 541 }
 542
 543 bool wxMacPrintPreview::Print(bool interactive)
 544 {
 545     if (!m_printPrintout)
 546         return false;
 547
 548     wxMacPrinter printer(&m_printDialogData);
 549     return printer.Print(m_previewFrame, m_printPrintout, interactive);
 550 }
 551
 552 void wxMacPrintPreview::DetermineScaling(void)
 553 {
 554     int screenWidth , screenHeight ;
 555     wxDisplaySize( &screenWidth , &screenHeight ) ;
 556
 557     wxSize ppiScreen( 72 , 72 ) ;
 558     wxSize ppiPrinter( 72 , 72 ) ;
 559
 560     // Note that with Leopard, screen dpi=72 is no longer a given
 561     m_previewPrintout->SetPPIScreen( ppiScreen.x , ppiScreen.y ) ;
 562
 563     wxCoord w , h ;
 564     wxCoord ww, hh;
 565     wxRect paperRect;
 566
 567     // Get a device context for the currently selected printer
 568     wxPrinterDC printerDC(m_printDialogData.GetPrintData());
 569     if (printerDC.Ok())
 570     {
 571         printerDC.GetSizeMM(&ww, &hh);
 572         printerDC.GetSize( &w , &h ) ;
 573         ppiPrinter = printerDC.GetPPI() ;
 574         paperRect = printerDC.GetPaperRect();
 575         m_isOk = true ;
 576     }
 577     else
 578     {
 579         // use some defaults
 580         w = 8 * 72 ;
 581         h = 11 * 72 ;
 582         ww = (wxCoord) (w * 25.4 / ppiPrinter.x) ;
 583         hh = (wxCoord) (h * 25.4 / ppiPrinter.y) ;
 584         paperRect = wxRect(0, 0, w, h);
 585         m_isOk = false ;
 586     }
 587     m_pageWidth = w;
 588     m_pageHeight = h;
 589
 590     m_previewPrintout->SetPageSizePixels(w , h) ;
 591     m_previewPrintout->SetPageSizeMM(ww, hh);
 592     m_previewPrintout->SetPaperRectPixels(paperRect);
 593     m_previewPrintout->SetPPIPrinter( ppiPrinter.x , ppiPrinter.y ) ;
 594
 595     m_previewScaleX = float(ppiScreen.x) / ppiPrinter.x;
 596     m_previewScaleY = float(ppiScreen.y) / ppiPrinter.y;
 597 }
 598
 599 #endif