qprintdialog_win.cpp

Go to the documentation of this file.

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
 
#include <QtPrintSupport/qtprintsupportglobal.h>
 
#include "qprintdialog.h"
 
#include <qwidget.h>
#include <qapplication.h>
#include <qmessagebox.h>
#include <private/qapplication_p.h>
 
#include "qabstractprintdialog_p.h"
#include <private/qprintengine_win_p.h>
#include "../kernel/qprinter_p.h"
 
#if !defined(PD_NOCURRENTPAGE)
#define PD_NOCURRENTPAGE    0x00800000
#define PD_RESULT_PRINT 1
#define PD_RESULT_APPLY 2
#define START_PAGE_GENERAL  0XFFFFFFFF
#endif
 
QT_BEGIN_NAMESPACE
 
using namespace Qt::StringLiterals;
 
//extern void qt_win_eatMouseMove();
 
class QPrintDialogPrivate : public QAbstractPrintDialogPrivate
{
    Q_DECLARE_PUBLIC(QPrintDialog)
public:
    QPrintDialogPrivate()
        : engine(0), ep(0)
    {
    }
 
    int openWindowsPrintDialogModally();
 
    QWin32PrintEngine *engine;
    QWin32PrintEnginePrivate *ep;
};
 
static void qt_win_setup_PRINTDLGEX(PRINTDLGEX *pd, QWindow *parentWindow,
                                    QPrintDialog *pdlg,
                                    QPrintDialogPrivate *d, HGLOBAL *tempDevNames)
{
    DEVMODE *devMode = d->ep->devMode;
 
    if (devMode) {
        int size = sizeof(DEVMODE) + devMode->dmDriverExtra;
        pd->hDevMode = GlobalAlloc(GHND, size);
        {
            void *dest = GlobalLock(pd->hDevMode);
            memcpy(dest, devMode, size);
            GlobalUnlock(pd->hDevMode);
        }
    } else {
        pd->hDevMode = NULL;
    }
    pd->hDevNames  = tempDevNames;
 
    pd->Flags = PD_RETURNDC;
    pd->Flags |= PD_USEDEVMODECOPIESANDCOLLATE;
 
    if (!pdlg->testOption(QPrintDialog::PrintSelection))
        pd->Flags |= PD_NOSELECTION;
    if (pdlg->testOption(QPrintDialog::PrintPageRange)) {
        pd->nMinPage = pdlg->minPage();
        pd->nMaxPage = pdlg->maxPage();
    }
 
    if (!pdlg->testOption(QPrintDialog::PrintToFile))
        pd->Flags |= PD_DISABLEPRINTTOFILE;
 
    if (pdlg->testOption(QPrintDialog::PrintSelection) && pdlg->printRange() == QPrintDialog::Selection)
        pd->Flags |= PD_SELECTION;
    else if (pdlg->testOption(QPrintDialog::PrintPageRange) && pdlg->printRange() == QPrintDialog::PageRange)
        pd->Flags |= PD_PAGENUMS;
    else if (pdlg->testOption(QPrintDialog::PrintCurrentPage) && pdlg->printRange() == QPrintDialog::CurrentPage)
        pd->Flags |= PD_CURRENTPAGE;
    else
        pd->Flags |= PD_ALLPAGES;
 
    // As stated by MSDN, to enable collate option when minpage==maxpage==0
    // set the PD_NOPAGENUMS flag
    if (pd->nMinPage==0 && pd->nMaxPage==0)
        pd->Flags |= PD_NOPAGENUMS;
 
    // Disable Current Page option if not required as default is Enabled
    if (!pdlg->testOption(QPrintDialog::PrintCurrentPage))
        pd->Flags |= PD_NOCURRENTPAGE;
 
    // Default to showing the General tab first
    pd->nStartPage = START_PAGE_GENERAL;
 
    // We don't support more than one page range in the QPrinter API yet.
    pd->nPageRanges = 1;
    pd->nMaxPageRanges = 1;
 
    if (d->ep->printToFile)
        pd->Flags |= PD_PRINTTOFILE;
 
    WId wId = parentWindow ? parentWindow->winId() : 0;
    //QTBUG-118899 PrintDlg needs valid window handle in hwndOwner
    //So in case there is no valid handle in the application,
    //use the desktop as valid handle.
    pd->hwndOwner = wId != 0 ? HWND(wId) : GetDesktopWindow();
    pd->lpPageRanges[0].nFromPage = qMax(pdlg->fromPage(), pdlg->minPage());
    pd->lpPageRanges[0].nToPage   = (pdlg->toPage() > 0) ? qMin(pdlg->toPage(), pdlg->maxPage()) : 1;
    pd->nCopies = d->printer->copyCount();
}
 
static void qt_win_read_back_PRINTDLGEX(PRINTDLGEX *pd, QPrintDialog *pdlg, QPrintDialogPrivate *d)
{
    if (pd->Flags & PD_SELECTION) {
        pdlg->setPrintRange(QPrintDialog::Selection);
        pdlg->printer()->setPageRanges(QPageRanges());
    } else if (pd->Flags & PD_PAGENUMS) {
        pdlg->setPrintRange(QPrintDialog::PageRange);
        pdlg->setFromTo(pd->lpPageRanges[0].nFromPage, pd->lpPageRanges[0].nToPage);
    } else if (pd->Flags & PD_CURRENTPAGE) {
        pdlg->setPrintRange(QPrintDialog::CurrentPage);
       pdlg->printer()->setPageRanges(QPageRanges());
    } else { // PD_ALLPAGES
        pdlg->setPrintRange(QPrintDialog::AllPages);
        pdlg->printer()->setPageRanges(QPageRanges());
    }
 
    d->ep->printToFile = (pd->Flags & PD_PRINTTOFILE) != 0;
 
    d->engine->setGlobalDevMode(pd->hDevNames, pd->hDevMode);
 
    if (d->ep->printToFile && d->ep->fileName.isEmpty())
        d->ep->fileName = "FILE:"_L1;
    else if (!d->ep->printToFile && d->ep->fileName == "FILE:"_L1)
        d->ep->fileName.clear();
}
 
static bool warnIfNotNative(QPrinter *printer)
{
    if (printer->outputFormat() != QPrinter::NativeFormat) {
        qWarning("QPrintDialog: Cannot be used on non-native printers");
        return false;
    }
    return true;
}
 
QPrintDialog::QPrintDialog(QPrinter *printer, QWidget *parent)
    : QAbstractPrintDialog( *(new QPrintDialogPrivate), printer, parent)
{
    Q_D(QPrintDialog);
    if (!warnIfNotNative(d->printer))
        return;
    d->engine = static_cast<QWin32PrintEngine *>(d->printer->printEngine());
    d->ep = static_cast<QWin32PrintEngine *>(d->printer->printEngine())->d_func();
    setAttribute(Qt::WA_DontShowOnScreen);
}
 
QPrintDialog::QPrintDialog(QWidget *parent)
    : QAbstractPrintDialog( *(new QPrintDialogPrivate), 0, parent)
{
    Q_D(QPrintDialog);
    if (!warnIfNotNative(d->printer))
        return;
    d->engine = static_cast<QWin32PrintEngine *>(d->printer->printEngine());
    d->ep = static_cast<QWin32PrintEngine *>(d->printer->printEngine())->d_func();
    setAttribute(Qt::WA_DontShowOnScreen);
}
 
QPrintDialog::~QPrintDialog()
{
}
 
int QPrintDialog::exec()
{
    if (!warnIfNotNative(printer()))
        return 0;
 
    Q_D(QPrintDialog);
    return d->openWindowsPrintDialogModally();
}
 
int QPrintDialogPrivate::openWindowsPrintDialogModally()
{
    Q_Q(QPrintDialog);
    QWindow *parentWindow = q->windowHandle() ? q->windowHandle()->transientParent() : nullptr;
    if (!parentWindow) {
        QWidget *parent = q->parentWidget();
        if (parent)
            parent = parent->window();
        else
            parent = QApplication::activeWindow();
 
        // If there is no window, fall back to the print dialog itself
        if (!parent)
            parent = q;
 
        parentWindow = parent->windowHandle();
    }
 
    q->QDialog::setVisible(true);
 
    HGLOBAL *tempDevNames = engine->createGlobalDevNames();
 
    bool done;
    bool result;
    bool doPrinting;
 
    PRINTPAGERANGE pageRange;
    PRINTDLGEX pd;
    memset(&pd, 0, sizeof(PRINTDLGEX));
    pd.lStructSize = sizeof(PRINTDLGEX);
    pd.lpPageRanges = &pageRange;
    qt_win_setup_PRINTDLGEX(&pd, parentWindow, q, this, tempDevNames);
 
    do {
        done = true;
        doPrinting = false;
        result = (PrintDlgEx(&pd) == S_OK);
        if (result && (pd.dwResultAction == PD_RESULT_PRINT
                       || pd.dwResultAction == PD_RESULT_APPLY))
        {
            doPrinting = (pd.dwResultAction == PD_RESULT_PRINT);
            if ((pd.Flags & PD_PAGENUMS)
                && (pd.lpPageRanges[0].nFromPage > pd.lpPageRanges[0].nToPage))
            {
                pd.lpPageRanges[0].nFromPage = 1;
                pd.lpPageRanges[0].nToPage = 1;
                done = false;
            }
            if (pd.hDC == 0)
                result = false;
        }
 
        if (!done) {
            QMessageBox::warning(nullptr,
                                 QPrintDialog::tr("Print"),
                                 QPrintDialog::tr("The 'From' value cannot be greater than the 'To' value."));
        }
    } while (!done);
 
    q->QDialog::setVisible(false);
 
//    qt_win_eatMouseMove();
 
    // write values back...
    if (result && (pd.dwResultAction == PD_RESULT_PRINT
                   || pd.dwResultAction == PD_RESULT_APPLY))
    {
        qt_win_read_back_PRINTDLGEX(&pd, q, this);
        // update printer validity
        printer->d_func()->validPrinter = !printer->printerName().isEmpty();
    }
 
    // Cleanup...
    GlobalFree(tempDevNames);
 
    q->done(result && doPrinting);
 
    return result && doPrinting;
}
 
void QPrintDialog::setVisible(bool visible)
{
    Q_D(QPrintDialog);
 
    // its always modal, so we cannot hide a native print dialog
    if (!visible)
        return;
 
    if (!warnIfNotNative(d->printer))
        return;
 
    (void)d->openWindowsPrintDialogModally();
    return;
}
 
QT_END_NAMESPACE
 
#include "moc_qprintdialog.cpp"