File indexing completed on 2024-04-28 04:32:42

 /*
     SPDX-FileCopyrightText: 2007, 2010 John Layt <john@layt.net>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 // This Class is a temporary addition to Okular for the duration of KDE 4.0.
 // In KDE 4.1 this class will either be moved to kdelibs if still required,
 // or replaced  with a Qt 4.4 based solution.
 
 #ifndef FILEPRINTER_H
 #define FILEPRINTER_H
 
 #include <QList>
 #include <QPrinter>
 #include <QString>
 
 #include "document.h"
 #include "okularcore_export.h"
 
 class QSize;
 
 namespace Okular
 {
 class OKULARCORE_EXPORT FilePrinter
 {
 public:
     /** Whether file(s) get deleted by the application or by the print system.
      *
      *  You may need to chose system deletion if your temp file clean-up
      *  deletes the file before the print system is finished with it.
      */
     enum FileDeletePolicy { ApplicationDeletesFiles, SystemDeletesFiles };
 
     /** Whether pages to be printed are selected by the application or the print system.
      *
      *  If application side, then the generated file will only contain those pages
      *  selected by the user, so FilePrinter will print all the pages in the file.
      *
      *  If system side, then the file will contain all the pages in the document, and
      *  the print system will print the users selected print range from out of the file.
      *
      *  Note system side only works in CUPS, not LPR.
      */
     enum PageSelectPolicy { ApplicationSelectsPages, SystemSelectsPages };
 
     /** Whether to apply scaling when printing.
      *
      * 'NoScaling' indicates that no scaling should be applied.
      * 'FitToPrintArea' indicates that the document should be scaled to the
      * area that is available for printing. Whether or not this includes the printer's
      * hardware margins depends on the value of 'QPrinter::fullPage()' for the given printer.
      *
      * @since 1.8
      */
     enum ScaleMode { NoScaling = 0, FitToPrintArea = 1 };
 
     /** Print a file using the settings in QPrinter
      *
      *  Only supports CUPS and LPR on *NIX.  Page Range only supported in CUPS.
      *  Most settings unsupported by LPR, some settings unsupported by CUPS.
      *
      *  The documentOrientation parameter was added in version 0.14.
      *
      * @param printer the print settings to use
      * @param file the file to print
      * @param documentOrientation the orientation stored in the document itself
      * @param scaleMode scale mode to use
      * @param fileDeletePolicy if the application or system deletes the file
      * @param pageSelectPolicy if the application or system selects the pages to print
      * @param pageRange page range to print if SystemSelectsPages and user chooses Selection in Print Dialog
      *
      * @returns Returns exit code:
      *          -9 if lpr not found
      *          -8 if empty file name
      *          -7 if unable to find file
      *          -6 if invalid printer state
      *          -5 if print to file copy failed
      *          -2 if the KProcess could not be started
      *          -1 if the KProcess crashed
      *          otherwise the KProcess exit code
      *
      * @since 1.8
      */
     static Document::PrintError printFile(QPrinter &printer,
                                           const QString &file,
                                           QPageLayout::Orientation documentOrientation,
                                           FileDeletePolicy fileDeletePolicy = FilePrinter::ApplicationDeletesFiles,
                                           PageSelectPolicy pageSelectPolicy = FilePrinter::ApplicationSelectsPages,
                                           const QString &pageRange = QString(),
                                           ScaleMode scaleMode = ScaleMode::FitToPrintArea);
 
     /** Return the list of pages selected by the user in the Print Dialog
      *
      * @param printer the print settings to use
      * @param lastPage the last page number, needed if AllPages option is selected
      * @param currentPage the current page number, needed if CurrentPage option is selected
      * @param selectedPageList list of pages to use if Selection option is selected
      * @returns Returns list of pages to print
      */
     static QList<int> pageList(QPrinter &printer, int lastPage, int currentPage, const QList<int> &selectedPageList);
 
     /** Return if Ghostscript ps2pdf is available on this system
      *
      * @returns Returns true if Ghostscript ps2pdf available
      */
     static bool ps2pdfAvailable();
 
     /** Return if Ghostscript pdf2ps is available on this system
      *
      * @returns Returns true if Ghostscript pdf2ps available
      */
     static bool pdf2psAvailable();
 
 private:
     /** Return if CUPS Print System is available on this system
      *
      * @returns Returns true if CUPS available
      */
     static bool cupsAvailable();
 
     Document::PrintError
     doPrintFiles(QPrinter &printer, const QStringList &fileList, FileDeletePolicy fileDeletePolicy, PageSelectPolicy pageSelectPolicy, const QString &pageRange, QPageLayout::Orientation documentOrientation, ScaleMode scaleMode);
 
     /// @since 1.8
     QStringList printArguments(QPrinter &printer,
                                FileDeletePolicy fileDeletePolicy,
                                PageSelectPolicy pageSelectPolicy,
                                bool useCupsOptions,
                                const QString &pageRange,
                                const QString &version,
                                QPageLayout::Orientation documentOrientation,
                                ScaleMode scaleMode);
 
     QStringList destination(QPrinter &printer, const QString &version);
     QStringList copies(QPrinter &printer, const QString &version);
     QStringList jobname(QPrinter &printer, const QString &version);
     QStringList deleteFile(QPrinter &printer, FileDeletePolicy fileDeletePolicy, const QString &version);
     QStringList pages(QPrinter &printer, PageSelectPolicy pageSelectPolicy, const QString &pageRange, bool useCupsOptions, const QString &version);
 
     /// @since 1.8
     QStringList cupsOptions(QPrinter &printer, QPageLayout::Orientation documentOrientation, ScaleMode scaleMode);
     QStringList optionMedia(QPrinter &printer);
     QString mediaPageSize(QPrinter &printer);
     QString mediaPaperSource(QPrinter &printer);
     QStringList optionOrientation(QPrinter &printer, QPageLayout::Orientation documentOrientation);
     QStringList optionDoubleSidedPrinting(QPrinter &printer);
     QStringList optionPageOrder(QPrinter &printer);
     QStringList optionCollateCopies(QPrinter &printer);
     /// @since 1.8
     QStringList optionPageMargins(QPrinter &printer, ScaleMode scaleMode);
     QStringList optionCupsProperties(QPrinter &printer);
 };
 
 }
 
 #endif // FILEPRINTER_H