Loading...
Searching...
No Matches
PDFDocViewPrefs.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#ifndef PDFTRON_H_CPPPDFPDFDocViewPrefs
6#define PDFTRON_H_CPPPDFPDFDocViewPrefs
7
8#include <C/PDF/TRN_PDFDocViewPrefs.h>
9#include <PDF/Page.h>
10#include <PDF/Destination.h>
11
12 namespace pdftron {
13 namespace PDF {
14
25 class PDFDocViewPrefs
26{
27 public:
28
47 void SetInitialPage(Destination& dest);
48
61 enum PageMode
62 {
63 e_UseNone,
64 e_UseThumbs,
65 e_UseBookmarks,
66 e_FullScreen,
67 e_UseOC,
68 e_UseAttachments
69 };
70
77 void SetPageMode(PageMode mode);
78
82 PageMode GetPageMode();
83
110 enum PageLayout
111 {
112 e_Default,
113 e_SinglePage,
114 e_OneColumn,
115 e_TwoColumnLeft,
116 e_TwoColumnRight,
117 e_TwoPageLeft,
118 e_TwoPageRight
119 };
120
128 void SetLayoutMode(PageLayout layout);
129
133 PageLayout GetLayoutMode();
134
166 enum ViewerPref
167 {
168 e_HideToolbar,
169 e_HideMenubar,
170 e_HideWindowUI,
171 e_FitWindow,
172 e_CenterWindow,
173 e_DisplayDocTitle,
174 };
175
182 void SetPref(ViewerPref pref, bool value);
183
188 bool GetPref(ViewerPref pref);
189
200 void SetNonFullScreenPageMode(PageMode mode);
201
207 PageMode GetNonFullScreenPageMode();
208
223 void SetDirection(bool left_to_right);
224
230 bool GetDirection();
231
240 void SetViewArea(Page::Box box);
241
246 Page::Box GetViewArea();
247
255 void SetViewClip(Page::Box box);
256
261 Page::Box GetViewClip();
262
270 void SetPrintArea(Page::Box box);
271
276 Page::Box GetPrintArea();
277
285 void SetPrintClip(Page::Box box);
286
291 Page::Box GetPrintClip();
292
297 SDF::Obj GetSDFObj();
298
304 PDFDocViewPrefs (SDF::Obj tr);
305 PDFDocViewPrefs (const PDFDocViewPrefs&);
306 PDFDocViewPrefs& operator= (const PDFDocViewPrefs&);
307
308 //added default constructor for swig
309 PDFDocViewPrefs ();
310
311// @cond PRIVATE_DOC
312#ifndef SWIGHIDDEN
313 TRN_PDFDocViewPrefs mp_prefs;
314 PDFDocViewPrefs(TRN_PDFDocViewPrefs impl);
315#endif
316// @endcond
317};
318
319
320
321#include <Impl/PDFDocViewPrefs.inl>
322
323
324 }; // namespace PDF
325}; // namespace pdftron
326
327#endif // PDFTRON_H_CPPPDFPDFDocViewPrefs
Destination.h
Page.h
pdftron::PDF::Destination
Definition Destination.h:31
pdftron::PDF::PDFDocViewPrefs::SetNonFullScreenPageMode
void SetNonFullScreenPageMode(PageMode mode)
pdftron::PDF::PDFDocViewPrefs::SetLayoutMode
void SetLayoutMode(PageLayout layout)
pdftron::PDF::PDFDocViewPrefs::SetViewClip
void SetViewClip(Page::Box box)
pdftron::PDF::PDFDocViewPrefs::GetSDFObj
SDF::Obj GetSDFObj()
pdftron::PDF::PDFDocViewPrefs::SetViewArea
void SetViewArea(Page::Box box)
pdftron::PDF::PDFDocViewPrefs::GetPrintArea
Page::Box GetPrintArea()
pdftron::PDF::PDFDocViewPrefs::GetDirection
bool GetDirection()
pdftron::PDF::PDFDocViewPrefs::ViewerPref
ViewerPref
Definition PDFDocViewPrefs.h:167
pdftron::PDF::PDFDocViewPrefs::e_FitWindow
@ e_FitWindow
Definition PDFDocViewPrefs.h:171
pdftron::PDF::PDFDocViewPrefs::e_CenterWindow
@ e_CenterWindow
Definition PDFDocViewPrefs.h:172
pdftron::PDF::PDFDocViewPrefs::e_HideWindowUI
@ e_HideWindowUI
Definition PDFDocViewPrefs.h:170
pdftron::PDF::PDFDocViewPrefs::e_HideToolbar
@ e_HideToolbar
Definition PDFDocViewPrefs.h:168
pdftron::PDF::PDFDocViewPrefs::e_DisplayDocTitle
@ e_DisplayDocTitle
Definition PDFDocViewPrefs.h:173
pdftron::PDF::PDFDocViewPrefs::e_HideMenubar
@ e_HideMenubar
Definition PDFDocViewPrefs.h:169
pdftron::PDF::PDFDocViewPrefs::SetPref
void SetPref(ViewerPref pref, bool value)
pdftron::PDF::PDFDocViewPrefs::SetPrintClip
void SetPrintClip(Page::Box box)
pdftron::PDF::PDFDocViewPrefs::GetPref
bool GetPref(ViewerPref pref)
pdftron::PDF::PDFDocViewPrefs::SetInitialPage
void SetInitialPage(Destination &dest)
pdftron::PDF::PDFDocViewPrefs::PDFDocViewPrefs
PDFDocViewPrefs(const PDFDocViewPrefs &)
pdftron::PDF::PDFDocViewPrefs::PDFDocViewPrefs
PDFDocViewPrefs()
pdftron::PDF::PDFDocViewPrefs::operator=
PDFDocViewPrefs & operator=(const PDFDocViewPrefs &)
pdftron::PDF::PDFDocViewPrefs::GetViewArea
Page::Box GetViewArea()
pdftron::PDF::PDFDocViewPrefs::GetPageMode
PageMode GetPageMode()
pdftron::PDF::PDFDocViewPrefs::SetPrintArea
void SetPrintArea(Page::Box box)
pdftron::PDF::PDFDocViewPrefs::PageMode
PageMode
Definition PDFDocViewPrefs.h:62
pdftron::PDF::PDFDocViewPrefs::e_UseThumbs
@ e_UseThumbs
Definition PDFDocViewPrefs.h:64
pdftron::PDF::PDFDocViewPrefs::e_UseNone
@ e_UseNone
Definition PDFDocViewPrefs.h:63
pdftron::PDF::PDFDocViewPrefs::e_FullScreen
@ e_FullScreen
Definition PDFDocViewPrefs.h:66
pdftron::PDF::PDFDocViewPrefs::e_UseOC
@ e_UseOC
Definition PDFDocViewPrefs.h:67
pdftron::PDF::PDFDocViewPrefs::e_UseAttachments
@ e_UseAttachments
Definition PDFDocViewPrefs.h:68
pdftron::PDF::PDFDocViewPrefs::e_UseBookmarks
@ e_UseBookmarks
Definition PDFDocViewPrefs.h:65
pdftron::PDF::PDFDocViewPrefs::SetPageMode
void SetPageMode(PageMode mode)
pdftron::PDF::PDFDocViewPrefs::SetDirection
void SetDirection(bool left_to_right)
pdftron::PDF::PDFDocViewPrefs::PageLayout
PageLayout
Definition PDFDocViewPrefs.h:111
pdftron::PDF::PDFDocViewPrefs::e_Default
@ e_Default
Definition PDFDocViewPrefs.h:112
pdftron::PDF::PDFDocViewPrefs::e_TwoColumnLeft
@ e_TwoColumnLeft
Definition PDFDocViewPrefs.h:115
pdftron::PDF::PDFDocViewPrefs::e_TwoPageLeft
@ e_TwoPageLeft
Definition PDFDocViewPrefs.h:117
pdftron::PDF::PDFDocViewPrefs::e_TwoColumnRight
@ e_TwoColumnRight
Definition PDFDocViewPrefs.h:116
pdftron::PDF::PDFDocViewPrefs::e_OneColumn
@ e_OneColumn
Definition PDFDocViewPrefs.h:114
pdftron::PDF::PDFDocViewPrefs::e_SinglePage
@ e_SinglePage
Definition PDFDocViewPrefs.h:113
pdftron::PDF::PDFDocViewPrefs::e_TwoPageRight
@ e_TwoPageRight
Definition PDFDocViewPrefs.h:118
pdftron::PDF::PDFDocViewPrefs::GetLayoutMode
PageLayout GetLayoutMode()
pdftron::PDF::PDFDocViewPrefs::GetPrintClip
Page::Box GetPrintClip()
pdftron::PDF::PDFDocViewPrefs::GetNonFullScreenPageMode
PageMode GetNonFullScreenPageMode()
pdftron::PDF::PDFDocViewPrefs::PDFDocViewPrefs
PDFDocViewPrefs(SDF::Obj tr)
pdftron::PDF::PDFDocViewPrefs::GetViewClip
Page::Box GetViewClip()
pdftron::PDF::Page::Box
Box
Definition Page.h:99
pdftron::SDF::Obj
Definition Obj.h:41
pdftron::PDF
Definition Action.h:15
pdftron
Definition BasicTypes.h:10