Foxit PDF SDK

fs_pdfdocviewerprefs.h
浏览该文件的文档.
1
15 #ifndef FS_PDFDOCVIEWERPREFS_H_
16 #define FS_PDFDOCVIEWERPREFS_H_
17
18 #include "common/fs_common.h"
19 #include "fs_pdfdoc.h"
20 #include "objects/fs_pdfobject.h"
21
27 namespace foxit {
31 namespace pdf {
40 class DocViewerPrefs FS_FINAL : public Base {
41 public:
47 typedef enum _PrintScale {
49 e_PrintScaleNone = 0,
51 e_PrintScaleAppDefault = 1
52 } PrintScale;
53
59 typedef enum _ViewerPref {
61 e_HideToolbar = 0,
63 e_HideMenubar = 1,
68 e_HideWindowUI = 2,
70 e_FitWindow = 3,
72 e_CenterWindow = 4,
77 e_DisplayDocTitle = 5
78 } ViewerPref;
79
80
98 explicit DocViewerPrefs(const PDFDoc& document, objects::PDFDictionary* pdf_dict = NULL);
99
101 ~DocViewerPrefs();
107 DocViewerPrefs(const DocViewerPrefs& other);
115 DocViewerPrefs& operator = (const DocViewerPrefs& other);
116
124 bool operator == (const DocViewerPrefs& other) const;
132 bool operator != (const DocViewerPrefs& other) const;
140 bool IsEmpty() const;
149 bool GetUIDisplayStatus(ViewerPref pref) const;
150
163 void SetUIDisplayStatus(ViewerPref pref, bool value);
164
180 PDFDoc::DisplayMode GetNonFullScreenPageMode() const;
181
199 void SetNonFullScreenPageMode(PDFDoc::DisplayMode display_mode);
200
210 bool GetReadingDirection() const;
211
224 void SetReadingDirection(bool is_left_to_right);
225
232 PDFPage::BoxType GetViewArea();
233
242 void SetViewArea(PDFPage::BoxType box_type);
243
250 PDFPage::BoxType GetViewClip();
251
260 void SetViewClip(PDFPage::BoxType box_type);
261
268 PDFPage::BoxType GetPrintArea();
269
278 void SetPrintArea(PDFPage::BoxType box_type);
279
286 PDFPage::BoxType GetPrintClip();
287
296 void SetPrintClip(PDFPage::BoxType box_type);
297
304 PrintScale GetPrintScale() const;
305
314 void SetPrintScale(PrintScale print_scale);
315
321 int GetPrintCopies() const;
322
331 void SetPrintCopies(int print_copies);
332
342 common::Range GetPrintRange() const;
343
354 void SetPrintRange(const common::Range& page_range);
355
361 objects::PDFDictionary* GetDict() const;
362
363 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
364 explicit DocViewerPrefs(FS_HANDLE handle = NULL);
365 };
366 } // namespace pdf
367 } // namespace foxit
368 #endif // FS_PDFDOCVIEWERPREFS_H_
369
foxit::pdf::DocViewerPrefs::e_HideMenubar
指定文档处于活动状态时是否隐藏查看器应用程序菜单栏的标志。
Definition: fs_pdfdocviewerprefs.h:63
foxit::pdf::DocViewerPrefs::GetNonFullScreenPageMode
PDFDoc::DisplayMode GetNonFullScreenPageMode() const
获取指定文档在退出全屏模式时如何显示文档的显示模式， 当文档的显示模式为全屏时。
foxit::pdf::DocViewerPrefs::e_CenterWindow
指定是否将文档窗口位置居中显示在屏幕中央的标志。
Definition: fs_pdfdocviewerprefs.h:72
foxit::pdf::DocViewerPrefs::SetPrintCopies
void SetPrintCopies(int print_copies)
设置为PDF文档打开打印对话框时要打印的副本数量。
foxit::pdf::DocViewerPrefs::SetViewArea
void SetViewArea(PDFPage::BoxType box_type)
设置表示在屏幕上查看文档时要显示的页面区域的页面边界。
foxit::FS_HANDLE
void * FS_HANDLE
句柄类型。
Definition: fs_basictypes.h:214
foxit::pdf::DocViewerPrefs::GetPrintArea
PDFPage::BoxType GetPrintArea()
获取表示打印文档时要渲染的页面区域的页面边界。
foxit::pdf::DocViewerPrefs::PrintScale
PrintScale
页面缩放选项的枚举。
Definition: fs_pdfdocviewerprefs.h:47
foxit::pdf::DocViewerPrefs::SetViewClip
void SetViewClip(PDFPage::BoxType box_type)
设置在屏幕上查看文档时页面内容要被裁剪的页面边界。
foxit::pdf::DocViewerPrefs::GetViewClip
PDFPage::BoxType GetViewClip()
获取在屏幕上查看文档时页面内容要被裁剪的页面边界。
foxit::pdf::DocViewerPrefs::e_FitWindow
指定是否调整文档窗口大小以适应第一个显示页面尺寸的标志。
Definition: fs_pdfdocviewerprefs.h:70
foxit::pdf::DocViewerPrefs::GetPrintRange
common::Range GetPrintRange() const
获取用于在为PDF文档打开打印对话框时初始化打印对话框的页面范围信息。
fs_common.h
通用定义和类的头文件。
foxit::pdf::PDFDoc::DisplayMode
DisplayMode
显示模式的枚举，指定文档打开时应如何显示。
Definition: fs_pdfdoc.h:988
foxit::pdf::DocViewerPrefs::~DocViewerPrefs
~DocViewerPrefs()
析构函数。
foxit::pdf::DocViewerPrefs::e_DisplayDocTitle
指定窗口标题栏是否应显示从文档信息字典的"Title"条目中获取的 文档标题的标志。如果为false，标题栏应显示包含文档的PDF文件名。
Definition: fs_pdfdocviewerprefs.h:77
foxit::pdf::DocViewerPrefs::SetPrintScale
void SetPrintScale(PrintScale print_scale)
设置为PDF文档显示打印对话框时要选择的页面缩放选项。
foxit::pdf::DocViewerPrefs::GetPrintScale
PrintScale GetPrintScale() const
获取为PDF文档显示打印对话框时要选择的页面缩放选项。
foxit::pdf::DocViewerPrefs::e_HideToolbar
指定文档处于活动状态时是否隐藏查看器应用程序工具栏的标志。
Definition: fs_pdfdocviewerprefs.h:61
foxit::pdf::DocViewerPrefs::ViewerPref
ViewerPref
文档打开时各种GUI元素应如何表现的枚举。
Definition: fs_pdfdocviewerprefs.h:59
foxit::pdf::DocViewerPrefs::DocViewerPrefs
DocViewerPrefs(const PDFDoc &document, objects::PDFDictionary *pdf_dict=0)
带参数的构造函数。
foxit::pdf::DocViewerPrefs
Definition: fs_pdfdocviewerprefs.h:40
foxit::pdf::DocViewerPrefs::GetPrintCopies
int GetPrintCopies() const
获取为PDF文档打开打印对话框时要打印的副本数量。
foxit::pdf::DocViewerPrefs::SetUIDisplayStatus
void SetUIDisplayStatus(ViewerPref pref, bool value)
设置指定查看器首选项类型的UI显示状态。
foxit::pdf::DocViewerPrefs::SetPrintRange
void SetPrintRange(const common::Range &page_range)
设置用于在为PDF文档打开打印对话框时初始化打印对话框的页面范围。
fs_pdfobject.h
PDF对象相关定义和类的头文件。
foxit::pdf::DocViewerPrefs::GetPrintClip
PDFPage::BoxType GetPrintClip()
获取打印文档时页面内容要被裁剪的页面边界。
foxit
Foxit命名空间。
Definition: fs_taggedpdf.h:27
foxit::pdf::DocViewerPrefs::SetPrintClip
void SetPrintClip(PDFPage::BoxType box_type)
设置打印文档时页面内容要被裁剪的页面边界。
foxit::pdf::DocViewerPrefs::SetNonFullScreenPageMode
void SetNonFullScreenPageMode(PDFDoc::DisplayMode display_mode)
设置指定文档在退出全屏模式时如何显示文档的显示模式， 当文档的显示模式为全屏时。
foxit::pdf::DocViewerPrefs::e_PrintScaleAppDefault
这表示应用程序应该使用当前的打印缩放。
Definition: fs_pdfdocviewerprefs.h:51
foxit::pdf::objects::PDFDictionary
Definition: fs_pdfobject.h:848
fs_pdfdoc.h
PDF文档相关定义和类的头文件。
foxit::pdf::DocViewerPrefs::GetUIDisplayStatus
bool GetUIDisplayStatus(ViewerPref pref) const
获取指定查看器首选项类型的UI显示状态。
NULL
#define NULL
空指针值。
Definition: fx_system.h:792
foxit::pdf::DocViewerPrefs::operator!=
bool operator!=(const DocViewerPrefs &other) const
不等于运算符。
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:771
foxit::pdf::DocViewerPrefs::GetViewArea
PDFPage::BoxType GetViewArea()
获取表示在屏幕上查看文档时要显示的页面区域的页面边界。
foxit::pdf::DocViewerPrefs::IsEmpty
bool IsEmpty() const
检查当前对象是否为空。
foxit::pdf::DocViewerPrefs::GetReadingDirection
bool GetReadingDirection() const
获取文本的主要阅读方向。
foxit::pdf::DocViewerPrefs::GetDict
objects::PDFDictionary * GetDict() const
从当前对象获取PDF字典。
foxit::pdf::DocViewerPrefs::e_HideWindowUI
指定是否隐藏文档窗口中的用户界面元素（如滚动条和导航控件）的标志， 只显示文档内容。
Definition: fs_pdfdocviewerprefs.h:68
foxit::pdf::DocViewerPrefs::SetReadingDirection
void SetReadingDirection(bool is_left_to_right)
设置文本的主要阅读方向。
foxit::common::Range
Definition: fs_common.h:1364
foxit::pdf::DocViewerPrefs::SetPrintArea
void SetPrintArea(PDFPage::BoxType box_type)
设置表示打印文档时要渲染的页面区域的页面边界。
foxit::pdf::PDFPage::BoxType
BoxType
页面框类型枚举。
Definition: fs_pdfpage.h:466
foxit::pdf::DocViewerPrefs::operator=
DocViewerPrefs & operator=(const DocViewerPrefs &other)
赋值运算符。
foxit::Base
Definition: fs_basictypes.h:449
foxit::pdf::DocViewerPrefs::operator==
bool operator==(const DocViewerPrefs &other) const
等于运算符。
foxit::pdf::DocViewerPrefs::e_PrintScaleNone
这表示打印对话框应该反映无页面缩放。
Definition: fs_pdfdocviewerprefs.h:49