Print.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2026 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFPrint
#define PDFTRON_H_CPPPDFPrint

#include <PDF/PDFDoc.h>
#include <C/PDF/TRN_Print.h>
#include <SDF/Obj.h>
#include <SDF/ObjSet.h>
#include <PDF/PageSet.h>

namespace pdftron{ 
    namespace PDF {

class PrinterMode; // forward declaration

class Print {
public:
    

    static void StartPrintJob( 
        PDFDoc & in_pdfdoc,
        const UString & in_printerName, 
        const UString & in_jobName,
        const UString & in_outputFileName,
        PageSet * in_pagesToPrint = NULL,
        PrinterMode * in_printerMode = NULL,
        volatile bool * in_cancel = NULL,
        OCG::Context * in_context = NULL);

    static void StartPrintJob( 
                       PDFDoc & in_pdfdoc,
                       const char * in_printerName, 
                       const char * in_jobName,
                       const char * in_outputFileName,
                       PageSet * in_pagesToPrint = NULL,
                       PrinterMode * in_printerMode = NULL,
                       volatile bool * in_cancel = NULL,
                       OCG::Context * in_context = NULL);

    static void StartPrintJob(
        PDFDoc& in_pdfdoc,
        const UString& in_printerName,
        const UString& in_jobName,
        const UString& in_outputFileName,
        const std::vector<UChar>& in_devmode_data,
        PageSet* in_pagesToPrint = NULL,
        PrinterMode* in_printerMode = NULL,
        volatile bool* in_cancel = NULL,
        OCG::Context* in_context = NULL);

    static void StartPrintJob(
        PDFDoc& in_pdfdoc,
        const char* in_printerName,
        const char* in_jobName,
        const char* in_outputFileName,
        const std::vector<UChar>& in_devmode_data,
        PageSet* in_pagesToPrint = NULL,
        PrinterMode* in_printerMode = NULL,
        volatile bool* in_cancel = NULL,
        OCG::Context* in_context = NULL);
};



class PrinterMode
{
public:
    enum PaperSize {
        e_PaperSize_PrinterDefault = -1,
        e_custom = 0,
        e_letter,
        e_letter_small,
        e_tabloid,
        e_ledger,
        e_legal,
        e_statement,
        e_executive,
        e_a3,
        e_a4,
        e_a4_small,
        e_a5,
        e_b4_jis,
        e_b5_jis,
        e_folio,
        e_quarto,
        e_10x14,
        e_11x17,
        e_note,
        e_envelope_9,
        e_envelope_10,
        e_envelope_11,
        e_envelope_12,
        e_envelope_14,
        e_c_size_sheet,
        e_d_size_sheet,
        e_e_size_sheet,     
        e_envelope_dl,
        e_envelope_c5,
        e_envelope_c3,
        e_envelope_c4,
        e_envelope_c6,
        e_envelope_c65,
        e_envelope_b4,
        e_envelope_b5,
        e_envelope_b6,
        e_envelope_italy,
        e_envelope_monarch,
        e_6_3_quarters_envelope,
        e_us_std_fanfold,
        e_german_std_fanfold,
        e_german_legal_fanfold,
        e_b4_iso,
        e_japanese_postcard,
        e_9x11,
        e_10x11,
        e_15x11,
        e_envelope_invite,
        e_reserved_48,
        e_reserved_49,
        e_letter_extra,
        e_legal_extra,
        e_tabloid_extra,
        e_a4_extra,
        e_letter_transverse,
        e_a4_transverse,
        e_letter_extra_transverse,
        e_supera_supera_a4,
        e_Superb_Superb_a3,
        e_letter_plus,
        e_a4_plus,
        e_a5_transverse,
        e_b5_jis_transverse,
        e_a3_extra,
        e_a5_extra,
        e_b5_iso_extra,
        e_a2,
        e_a3_transverse,
        e_a3_extra_transverse,
        e_japanese_double_postcard,
        e_a6,
        e_japanese_envelope_kaku_2,
        e_japanese_envelope_kaku_3,
        e_japanese_envelope_chou_3,
        e_japanese_envelope_chou_4,
        e_letter_rotated,
        e_a3_rotated,
        e_a4_rotated,
        e_a5_rotated,
        e_b4_jis_rotated,
        e_b5_jis_rotated,
        e_japanese_postcard_rotated,
        e_double_japanese_postcard_rotated,
        e_a6_rotated,
        e_japanese_envelope_kaku_2_rotated,
        e_japanese_envelope_kaku_3_rotated,
        e_japanese_envelope_chou_3_rotated,
        e_japanese_envelope_chou_4_rotated,
        e_b6_jis,
        e_b6_jis_rotated,
        e_12x11,
        e_japanese_envelope_you_4,
        e_japanese_envelope_you_4_rotated,
        e_prc_16k,
        e_prc_32k,
        e_prc_32k_big,
        e_prc_envelop_1,
        e_prc_envelop_2,
        e_prc_envelop_3,
        e_prc_envelop_4,
        e_prc_envelop_5,
        e_prc_envelop_6,
        e_prc_envelop_7,
        e_prc_envelop_8,
        e_prc_envelop_9,
        e_prc_envelop_10,
        e_prc_16k_rotated,
        e_prc_32k_rotated,
        e_prc_32k_big__rotated,
        e_prc_envelop_1_rotated,
        e_prc_envelop_2_rotated,
        e_prc_envelop_3_rotated,
        e_prc_envelop_4_rotated,
        e_prc_envelop_5_rotated,
        e_prc_envelop_6_rotated,
        e_prc_envelop_7_rotated,
        e_prc_envelop_8_rotated,
        e_prc_envelop_9_rotated,
        e_prc_envelop_10_rotated,
    };

    enum DuplexMode {
        e_Duplex_PrinterDefault = -1,       
        e_Duplex_Auto = 0,                  
        e_Duplex_None = 1,                  
        e_Duplex_LongSide = 2,              
        e_Duplex_ShortSide = 3              
    };

    enum OutputQuality {
        e_OutputQuality_PrinterDefault = -5, 
        e_OutputQuality_DPI = 0,            
        e_OutputQuality_Draft = -1,         
        e_OutputQuality_Low = -2,           
        e_OutputQuality_Medium = -3,        
        e_OutputQuality_High = -4           
    };

    enum OutputColor {
        e_OutputColor_PrinterDefault = -1,  
        e_OutputColor_Color = 0,            
        e_OutputColor_Grayscale = 1,        
        e_OutputColor_Monochrome = 2,       
    };
    
    enum Orientation
    {
        e_Orientation_PrinterDefault = -1,  
        e_Orientation_Portrait = 0,         
        e_Orientation_Landscape = 1         
    };

    enum ScaleType {
        e_ScaleType_PrinterDefault = -3,    
        e_ScaleType_MultiplePagesPerOutputPage = -2,
        e_ScaleType_CustomScale = -1,
        e_ScaleType_None = 0,               
        e_ScaleType_FitToOutputPage = 1,    
        e_ScaleType_ReduceToOutputPage = 2  
    };

    enum NUp {
        e_NUp_PrinterDefault = -2,          
        e_NUp_Custom = -1,                  
        e_NUp_1_1 = 0,                      
        e_NUp_2_1 = 1,                      
        e_NUp_2_2 = 2,                      
        e_NUp_3_2 = 3,                      
        e_NUp_3_3 = 4,                      
        e_NUp_4_4 = 5,                      
    };

    enum NUpPageOrder {
        e_PageOrder_PrinterDefault = -1,    
        e_PageOrder_LeftToRightThenTopToBottom = 0, 
        e_PageOrder_RightToLeftThenTopToBottom = 1,
        e_PageOrder_TopToBottomThenLeftToRight = 2,
        e_PageOrder_BottomToTopThenLeftToRight = 3
    };

    enum PrintContentTypes {
        e_PrintContent_DocumentOnly = 0,
        e_PrintContent_DocumentAndAnnotations = 1,          
        e_PrintContent_DocumentAnnotationsAndComments = 2
    };


    PrinterMode();
    ~PrinterMode();
    
    void SetAutoCenter(bool autoCenter);

    void SetAutoRotate(bool autoRotate);

    void SetCollation( bool collation );

    void SetCopyCount( int copyCount );

    void SetDPI( int dpi );

    void SetDuplexing( DuplexMode mode );

    void SetNUp(NUp nup, NUpPageOrder pageOrder = e_PageOrder_LeftToRightThenTopToBottom);

    void SetNUp(unsigned int x, unsigned int y, NUpPageOrder pageOrder = e_PageOrder_LeftToRightThenTopToBottom);

    void SetOrientation(Orientation orientation);

    void SetOutputAnnot(PrintContentTypes printContent);

    void SetOutputColor( OutputColor color );

    void SetOutputQuality( OutputQuality quality );

    void SetOutputPageBorder(bool printBorder);

    void SetPaperSize(const Rect & size = Rect(0, 0, 612, 791) );
    
    void SetPaperSize(pdftron::PDF::PrinterMode::PaperSize paperSize);

    void SetScale(double scale);

    void SetScaleType(ScaleType scaleType);
    
    void SetUseRleImageCompression( bool useRleImageCompression );


    // @cond PRIVATE_DOC

    #ifndef SWIGHIDDEN
    SDF::Obj m_printerMode;
    #endif
    // @endcond PRIVATE_DOC

private:
    SDF::ObjSet m_printerModeSet;
};

    }; // namespace PDF
}; // namespace pdftron

#include <Impl/Print.inl>

#endif // PDFTRON_H_CPPPDFPrint