PDFTool  6.0
PtlPDFDocument.h
1 // PtlPDFDocument.h
3 // Copyright (C) 2013-2018 Antenna House,Inc.
4 // All rights reserved.
6 #ifndef PDFTK_PTLPDFDOCUMENT_H_
7 #define PDFTK_PTLPDFDOCUMENT_H_
8 
9 #include "PtlOutline.h"
10 #include "PtlParamString.h"
11 #include "PtlSearchTextResults.h"
12 
13 namespace PdfTk {
14 
15 class PtlParamStream;
16 class PtlEncrypt;
17 class PtlDocProperty;
18 class PtlPages;
19 class PtlEmbeddedFiles;
20 class PtlParamWaterMark;
21 class PtlParamRestriction;
22 class PtlParamOptimize;
23 class PtlParamSearchTextAndHighlight;
24 class PtlParamSearchTextAndSetMask;
25 class PtlParamSearchText;
26 
31 class PDFTK_API PtlPDFDocument
32 {
33 public:
37  enum SAVE_OPTION {
38  SAVE_RECONSTRUCT = 0,
39  SAVE_LINEARIZE = 1,
40  SAVE_INCREMENTAL_UPDATE = 2
41  };
42 
43 private:
44  int m_documentHandle;
45 public:
46  int getHandle() const;
47 
48 public:
55 
63 
68 
69 public:
76 
77 public:
83  void setPassword(const PtlParamString& password);
84 
90  void load(PtlParamStream& inParam);
91 
92 public:
101 
107  void save(PtlParamStream& outParam);
108 
109 public:
115  bool isEncrypted() const;
116 
123 
145  bool hasOwnerAuthority() const;
146 
153 
164  void setEncrypt(const PtlEncrypt& encrypt);
165 
171 
177  bool isSignatured() const;
178 
184  bool isPDFA() const;
185 
191  bool isPDFX() const;
192 
193 public:
200 
201 public:
206  int getPageCount() const;
207 
214 
215 public:
221  bool hasOutlines() const;
222 
232 
233 public:
239  bool hasEmbeddedFiles() const;
240 
247 
248 public:
254  void appendWaterMark(const PtlParamWaterMark& waterMark);
255 
261  void removeWaterMark(const PtlParamString& name);
262 
263 public:
272  void setRestriction(const PtlParamRestriction& restriction);
273 
274 public:
281  bool optimize(const PtlParamOptimize& paramOptimize);
282 
291  bool embedFonts();
292 
293 public:
302 
311 
320 
321 public:
338  int searchTextAndDoProcess(const PtlParamSearchText& paramSearchText);
339 
350 };
351 
352 } // namespace PdfTk
353 
354 #endif // PDFTK_PTLPDFDOCUMENT_H_
355 
PdfTk::PtlPDFDocument::hasOutlines
bool hasOutlines() const
アウトラインを持っているかどうかを取得。
PdfTk::PtlPDFDocument::PtlPDFDocument
PtlPDFDocument(const PtlPDFDocument &obj)
コピーコンストラクタ alias copy
PdfTk::PtlPDFDocument::appendWaterMark
void appendWaterMark(const PtlParamWaterMark &waterMark)
透かしを設定。
PdfTk::PtlPDFDocument::setRestriction
void setRestriction(const PtlParamRestriction &restriction)
閲覧制限を設定。
PdfTk::PtlOutline
PDFのアウトラインを表現したクラスです。
Definition: PtlOutline.h:22
PdfTk::PtlPDFDocument::hasEmbeddedFiles
bool hasEmbeddedFiles() const
添付ファイルを持っているかどうかを取得。
PdfTk::PtlPDFDocument::removeWaterMark
void removeWaterMark(const PtlParamString &name)
透かしを削除。
PdfTk::PtlPDFDocument::load
void load(PtlParamStream &inParam)
PDF文書をロード。
PdfTk::PtlPDFDocument::getEmbeddedFiles
PtlEmbeddedFiles & getEmbeddedFiles() const
添付ファイルコンテナを取得。
PdfTk::PtlPDFDocument::exportAnnotsToFDF
void exportAnnotsToFDF(PtlParamStream &outParam)
FDF文書のエクスポート。
PdfTk::PtlPDFDocument::isEncryptedOnlyEmbeddedFiles
bool isEncryptedOnlyEmbeddedFiles() const
添付ファイルのみ暗号化されているかどうかを取得。
PdfTk::PtlPDFDocument::removeEncrypt
void removeEncrypt()
暗号化情報を削除。
PdfTk::PtlPDFDocument::setSaveOption
void setSaveOption(SAVE_OPTION option)
保存時のオプションを設定。
PdfTk::PtlPDFDocument::getDocProperty
PtlDocProperty & getDocProperty() const
文書プロパティを取得。
PdfTk::PtlPDFDocument::setEncrypt
void setEncrypt(const PtlEncrypt &encrypt)
暗号化情報を設定。
PdfTk::PtlParamString
文字列を扱うクラスです。
Definition: PtlParamString.h:27
PdfTk::PtlParamSearchText
テキスト検索のパラメータを表現したクラスです。 すべてのテキスト検索のパラメータを表現したクラスのベースクラスです。
Definition: PtlParamSearchText.h:21
PdfTk::PtlPDFDocument::getEncrypt
const PtlEncrypt & getEncrypt()
暗号化情報を取得。
PdfTk::PtlParamWaterMark
透かしの設定で使うパラメータクラスです。 すべての透かしパラメータクラスのベースクラスです。
Definition: PtlParamWaterMark.h:22
PdfTk::PtlPDFDocument::save
void save(PtlParamStream &outParam)
PDF文書を保存。
PdfTk::PtlPDFDocument::searchText
PtlSearchTextResults searchText(const PtlParamSearchText &paramSearchText)
テキスト検索。
PdfTk::PtlPDFDocument::importAnnotsFromPDF
void importAnnotsFromPDF(PtlParamStream &inParam)
マークアップ注釈のPDFからのインポート。
PdfTk::PtlPDFDocument::embedFonts
bool embedFonts()
フォント埋め込み。
PdfTk::PtlPDFDocument::getPageCount
int getPageCount() const
ページ数を取得。
PdfTk::PtlSearchTextResults
PrlPtlPDFDocument/PtlPageのsearchText関数で取得されるテキスト検索結果のコンテナを表現するクラスです。
Definition: PtlSearchTextResults.h:18
PdfTk::PtlParamOptimize
最適化に使うパラメータクラスです。
Definition: PtlParamOptimize.h:20
PdfTk::PtlPDFDocument::isPDFA
bool isPDFA() const
PDF/Aかどうかを取得。
PdfTk::PtlPDFDocument::isEncrypted
bool isEncrypted() const
暗号化されているかどうかを取得。
PdfTk::PtlPDFDocument::operator=
PtlPDFDocument & operator=(const PtlPDFDocument &obj)
コピーオペレータ alias copy
PdfTk::PtlPDFDocument::isPDFX
bool isPDFX() const
PDF/Xかどうかを取得。
PdfTk::PtlPDFDocument::PtlPDFDocument
PtlPDFDocument()
コンストラクタ
PdfTk::PtlPDFDocument::isSignatured
bool isSignatured() const
署名付きかどうかを取得。
PdfTk::PtlEmbeddedFiles
添付ファイルのコンテナを表現するクラスです。
Definition: PtlEmbeddedFiles.h:18
PdfTk::PtlParamStream
ファイルやストリームの入出力指定に使うベースクラスです。 PDFToolではstd::ifstreamを使うPtlParamInput、std::ofstreamを使うPtlParamOutputクラ...
Definition: PtlParamStream.h:19
PdfTk::PtlParamRestriction
PDFの閲覧制限を表現したクラスです。
Definition: PtlParamRestriction.h:22
PdfTk::PtlPDFDocument::optimize
bool optimize(const PtlParamOptimize &paramOptimize)
最適化。
PdfTk::PtlDocProperty
PDFの文書プロパティを表現したクラスです。 PtlDocPropertyはPtlPDFDocumentから取得して使用します。
Definition: PtlDocProperty.h:23
PdfTk::PtlPDFDocument::SAVE_OPTION
SAVE_OPTION
保存オプション
Definition: PtlPDFDocument.h:37
PdfTk::PtlPDFDocument::‾PtlPDFDocument
‾PtlPDFDocument()
デストラクタ
PdfTk::PtlPDFDocument::getRootOutline
PtlOutline getRootOutline() const
ルートアウトラインを取得。
PdfTk::PtlPDFDocument::hasOwnerAuthority
bool hasOwnerAuthority() const
オーナー権限があるかどうかを取得。
PdfTk::PtlPDFDocument
PDF文書を表現したクラスです。
Definition: PtlPDFDocument.h:32
PdfTk::PtlPages
ページのコンテナを表現するクラスです。
Definition: PtlPages.h:23
PdfTk::PtlPDFDocument::getPages
PtlPages & getPages()
ページコンテナを取得。
PdfTk::PtlPDFDocument::searchTextAndDoProcess
int searchTextAndDoProcess(const PtlParamSearchText &paramSearchText)
テキスト検索して後処理。
PdfTk::PtlPDFDocument::setPassword
void setPassword(const PtlParamString &password)
パスワードを設定。
PdfTk::PtlEncrypt
PDFのセキュリティハンドラおよび暗号化情報を表現したクラスです。 すべてのEncryptクラスのベースクラスです。
Definition: PtlEncrypt.h:21
PdfTk::PtlPDFDocument::importAnnotsFromFDF
void importAnnotsFromFDF(PtlParamStream &inParam)
FDF文書のインポート。