d0a6b55e88 | ||
---|---|---|
3rdparty_licenses | ||
CLA | ||
CodeGenerator | ||
JBIG2_Viewer | ||
Pdf4QtDocDiff | ||
Pdf4QtDocPageOrganizer | ||
Pdf4QtLib | ||
Pdf4QtViewer | ||
Pdf4QtViewerLite | ||
Pdf4QtViewerPlugins | ||
Pdf4QtViewerProfi | ||
PdfExampleGenerator | ||
PdfTool | ||
UnitTests | ||
VisualStudio | ||
WixInstaller | ||
qbs | ||
resources | ||
xfa | ||
.gitignore | ||
CMakeLists.txt | ||
LICENSE.txt | ||
NOTES.txt | ||
Pdf4Qt.pri | ||
Pdf4Qt.pro | ||
Pdf4Qt.qbs | ||
README.md | ||
RELEASES.txt | ||
explic.rtf | ||
generated_code_definition.xml | ||
qt.conf |
README.md
PDF4QT
(c) Jakub Melka 2018-2022
This software is consisting of PDF rendering library, and several applications, such as advanced document viewer, command line tool, and document page manipulator application. Software is implementing PDF functionality based on PDF Reference 2.0. It is written and maintained by Jakub Melka.
Software works on Microsoft Windows / Linux.
Software is provided without any warranty of any kind.
1. ACKNOWLEDGEMENTS
This software is based in part on the work of the Independent JPEG Group.
Portions of this software are copyright © 2019 The FreeType Project (www.freetype.org). All rights reserved.
2. LEGAL ISSUES
Both library and viewer uses more benevolent LGPL license, so it is more usable in commercial software, than GPL code only. Please see attached file - LICENSE.txt to see details. This software also uses several third party software, and user of this software must also respect licenses of third party libraries.
3. FEATURES
Software have following features (the list is not complete):
- multithreading support
- hardware accelerated rendering
- encryption
- color management
- optional content handling
- text layout analysis
- signature validation
- annotations
- form filling
- text to speech capability
- editation
- file attachments
- optimalization (compressing documents)
- command line tool
- audio book conversion
- internal structure inspector
- compare documents
- static XFA support (readonly, simple XFA only)
- electronically/digitally sign documents
- public key security encryption
- 3D PDF support (planned in year 2022)
- create fillable forms (planned in year 2023)
- watermarks / headers / footers (planned in year 2023)
- presentation application (planned in year 2023)
4. THIRD PARTY LIBRARIES
Several third-party libraries are used.
- libjpeg, see https://www.ijg.org/
- FreeType, see https://www.freetype.org/index.html, FTL license used
- OpenJPEG, implementing Jpeg2000, see https://www.openjpeg.org/, 2-clause MIT license
- Qt, https://www.qt.io/, LGPL license used
- OpenSSL, https://www.openssl.org/, Apache 2.0 license
- LittleCMS, http://www.littlecms.com/
- zlib, https://zlib.net/
5. CONTRIBUTIONS
If you want to contribute to this project, it is required, that you (contributor) fill and digitally sign document Contributor License Agreement, because I want to have a freedom to do whatever I want with my library, without obligation to someone else. But I would strongly prefer, if you want to contribute, to contribute in a form of testing, consultation, giving advices etc. I would like to write this library entirely by myself.
6. COMPILING
Compilation on Windows and Linux is available. There are two options for Windows, and one for Linux. To compile this project, compiler supporting C++20 is needed. On Windows, you can use Visual Studio 2019, clang or mingw. On linux, only GCC 10 was tested.
Compilation instructions (.pro file, Windows, Visual Studio):
- Download Visual Studio 2022
- Download Qt, minimal supported version is 5.15.2
- Download precompiled libraries, or compile them yourself. Libraries must be in same root directory as this project, so root folder of this project will have a sibling folder with these libraries
- Open Qt Creator and root project Pdf4Qt.pro
- Create target for Microsoft Visual Studio 2022 and compile the project
Compilation instructions (.qbs file, Windows/Linux)
For QBS build, you will need to install Conan, a C++ package manager, Qt framework (minimal supported version is 5.15.2), and compiler supporting C++20 (Visual Studio 2022, Clang, Mingw, GCC).
- Prepare prerequisites (Conan, Qt, compiler)
- Open QBS project file
- Build
7. DISCLAIMER
I wrote this project in my free time. I hope you will find it useful!