DocumentConversion.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2018 by PDFTron Systems Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
// !Warning! This file is autogenerated, modify the .codegen file, not this one
// (any changes here will be wiped out during the autogen process)

#ifndef PDFTRON_H_CPPPDFDocumentConversion
#define PDFTRON_H_CPPPDFDocumentConversion
#include <C/PDF/TRN_DocumentConversion.h>
#include <Common/BasicTypes.h>
#include <Common/UString.h>
#include <PDF/PDFDoc.h>

namespace pdftron { namespace PDF { 

class DocumentConversion
{
public:
    //enums:
    enum Result {
        eSuccess = 0,
        eIncomplete = 1,
        eFailure = 2
    };
    DocumentConversion();
    DocumentConversion(const DocumentConversion& other);
    DocumentConversion(TRN_DocumentConversion impl);
    DocumentConversion& operator= (const DocumentConversion& other);
    ~DocumentConversion();
    
    void Destroy();

    //methods:
    
    Result TryConvert();
    
    void Convert();
    
    void ConvertNextPage();
    
    PDF::PDFDoc GetDoc();
    
    Result GetConversionStatus() const;
    
    void CancelConversion();
    
    bool IsCancelled() const;
    
    bool HasProgressTracking() const;
    
    double GetProgress() const;
    
    UString GetProgressLabel() const;
    
    UInt32 GetNumConvertedPages() const;
    
    UString GetErrorString() const;
    
    UInt32 GetNumWarnings() const;
    
    UString GetWarningString(UInt32 index) const;

#ifndef SWIGHIDDEN
    TRN_DocumentConversion m_impl;
#endif

private:

#ifndef SWIGHIDDEN
    mutable bool m_owner; 
#endif
};

#include <Impl/DocumentConversion.inl>
} //end pdftron
} //end PDF


#endif //PDFTRON_H_CPPPDFDocumentConversion