HTML2PDF.h

Go to the documentation of this file.

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

#include <PDF/PDFDoc.h>
#include <PDF/Print.h>
#include <C/PDF/TRN_HTML2PDF.h>

namespace pdftron {
    namespace PDF {
        
class Proxy;
class WebPageSettings;
class TOCSettings;

class HTML2PDF
{
public:
    typedef pdftron::PDF::Proxy Proxy;
    typedef pdftron::PDF::WebPageSettings WebPageSettings;
    typedef pdftron::PDF::TOCSettings TOCSettings;

#ifndef SWIG

    static bool Convert(PDFDoc& doc, const UString& url);

    static bool Convert(PDFDoc& doc, const UString& url, const WebPageSettings& settings);
#endif

    void InsertFromURL(const UString& url);

    void InsertFromURL(const UString& url, const WebPageSettings& settings);

    void InsertFromHtmlString(const UString& html);

    void InsertFromHtmlString(const UString& html, const WebPageSettings& settings);

    void InsertTOC();

    void InsertTOC(const TOCSettings& settings);

    bool Convert(PDFDoc& doc);

    int GetHTTPErrorCode() const;

    void SetQuiet(bool quiet);

    void SetCompatibilityMode(bool compatibility);

    void SetSandbox(bool sandbox);

    void SetLogFilePath(const UString& path);

    UString GetLog() const;

    static void SetModulePath(const UString& path);


    static bool IsModuleAvailable();

    HTML2PDF();

    ~HTML2PDF();

    void SetPaperSize(PrinterMode::PaperSize size);  

    void SetPaperSize(const UString& width, const UString& height);

    void SetLandscape(bool enable);

    void SetDPI(int dpi);

    void SetOutline(bool enable, int depth = 4);

    void DumpOutline(const UString& xml_file);

    void SetPDFCompression(bool enable);

    void SetMargins(const UString& top, const UString& bottom, const UString& left, const UString& right);

     void SetHeader(const UString& header);

     void SetFooter(const UString& footer);

    void SetImageDPI(int dpi);

    void SetImageQuality(int quality);

    void SetCookieJar(const UString& path);

/* {{codegen: HTML2PDF}} */
        
    void AddCookie(const UString& name, const UString& value);
    
    void SetCustomHeader(const UString& name, const UString& value);
/* {{codegen: HTML2PDF}} */

     void Destroy();

    // @cond PRIVATE_DOC

    #ifndef SWIGHIDDEN
    TRN_HTML2PDF mp_html2pdf;
    #endif

private:
    HTML2PDF(const HTML2PDF&);
    HTML2PDF& operator= (const HTML2PDF&);
    // @endcond

};


class Proxy
{
public:
    Proxy();

    ~Proxy();

    enum Type { e_default, e_none, e_http, e_socks5 };
    void SetType(Type type);

    void SetHost(const UString& host);

    void SetPort(int port);

    void SetUsername(const UString& username);

    void SetPassword(const UString& password);

    void Destroy();

    // @cond PRIVATE_DOC

#ifndef SWIGHIDDEN
    TRN_HTML2PDF_Proxy mp_impl;
#endif
    // @endcond

};

class WebPageSettings
{
public:
    WebPageSettings();

    ~WebPageSettings();

    void SetPrintBackground(bool background);

    void SetLoadImages(bool load);

    void SetAllowJavaScript(bool enable);

    void SetSmartShrinking(bool enable);

    void SetMinimumFontSize(int size);

    void SetDefaultEncoding(const UString& encoding);

    void SetUserStyleSheet(const UString& url);

    void SetAllowPlugins(bool enable);

    void SetPrintMediaType(bool print);

    void SetIncludeInOutline(bool include);

    void SetUsername(const UString& username);

    void SetPassword(const UString& password);

    void SetJavaScriptDelay(int msec);

    void SetConvertDelay(int msec);

    void SetTimeout(int msec);

    void SetZoom(double zoom);

    void SetBlockLocalFileAccess(bool block);

    void SetStopSlowScripts(bool stop);

    void SetDebugJavaScriptOutput(bool forward);

    enum ErrorHandling {
        e_abort,    // Abort the conversion process.
        e_skip,     // Do not add the object to the final output
        e_ignore    // Try to add the object to the final output.
    };
    void SetLoadErrorHandling(ErrorHandling type);

    void SetExternalLinks(bool convert);

    void SetInternalLinks(bool convert);

    void SetProduceForms(bool forms);

    void SetProxy(const Proxy& proxy);

    void Destroy();

    // @cond PRIVATE_DOC

#ifndef SWIGHIDDEN
    TRN_HTML2PDF_WebPageSettings mp_impl;
#endif
    // @endcond

};

class TOCSettings
{
public:
    TOCSettings();

    ~TOCSettings();

    void SetDottedLines(bool enable);

    void SetLinks(bool enable);

    void SetCaptionText(const UString& caption);

    void SetLevelIndentation(int indentation);

    void SetTextSizeShrink(double shrink);

    void SetXsl(const UString& style_sheet);

    void Destroy();

    // @cond PRIVATE_DOC

#ifndef SWIGHIDDEN
    TRN_HTML2PDF_TOCSettings mp_impl;
#endif
    // @endcond

};

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

#include <Impl/HTML2PDF.inl>

#endif // PDFTRON_H_CPPPDFHTML2PDF