- Main Page
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
ContentEdit.h
Go to the documentation of this file.
1 //---------------------------------------------------------------------------------------
2 // Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
3 // Consult legal.txt regarding legal and license information.
4 //---------------------------------------------------------------------------------------
5
6 #ifndef PDFTRON_H_CPPPDFContentEdit
7 #define PDFTRON_H_CPPPDFContentEdit
8 #include <C/PDF/TRN_ContentEdit.h>
9
10 #include <Common/BasicTypes.h>
11 #include <Common/UString.h>
12 #include <PDF/PDFDoc.h>
13
14 namespace pdftron { namespace PDF {
15
16
17 /* doxygen ignore - this is not a public interface
18 * The class ContentEdit.
19 * static interface to Iceni Content Edit functionality
20 */
21 class ContentEdit
22 {
23 public:
24
25 /* Doxygen ignore - this is not a public interface
26 * Begin a PDF content editing session. Does not support concurrency.
27 * Only 1 PDF can be edited at a time.
28 *
29 * @param input_pdf The PDF to be edited.
30 */
31 static void Begin(PDFDoc& input_pdf);
32
33 /* doxygen ignore - this is not a public interface
34 * Runs the command XML
35 *
36 * @param commands_xml The command XML.
37 * @return results XML.
38 */
39 static UString RunXML(const UString& commands_xml);
40
41 /* doxygen ignore - this is not a public interface
42 * Ends the content editing session and finalizes changes.
43 */
44 static void End();
45 };
46
47 #include <Impl/ContentEdit.inl>
48 } //end pdftron
49 } //end PDF
50
51
52 #endif //PDFTRON_H_CPPPDFContentEdit
pdftron::PDF::ContentEdit::Begin
static void Begin(PDFDoc &input_pdf)
UString.h
pdftron::PDF::PDFDoc
Definition: PDFDoc.h:71
pdftron::PDF::ContentEdit::RunXML
static UString RunXML(const UString &commands_xml)
PDFDoc.h
BasicTypes.h
pdftron::PDF::ContentEdit
Definition: ContentEdit.h:21
pdftron::UString
Definition: UString.h:27
pdftron::PDF::ContentEdit::End
static void End()