Vanilla.PDF  1.5.3
Cross-platform toolkit for creating and modifying PDF documents
c_viewer_preferences.h
Go to the documentation of this file.
1 #ifndef _C_VIEWER_PREFERENCES_H
2 #define _C_VIEWER_PREFERENCES_H
3 
4 #include "vanillapdf/c_export.h"
5 #include "vanillapdf/c_handles.h"
6 #include "vanillapdf/c_values.h"
7 
8 #ifdef __cplusplus
9 extern "C"
10 {
11 #endif
12 
51  typedef enum {
52  NonFullScreenPageMode_Undefined = 0,
53 
58 
63 
68 
74 
78  typedef enum {
79  ReadingOrder_Undefined = 0,
80 
85 
92  } ReadingOrder;
93 
99  typedef enum {
100  PrintScaling_Undefined = 0,
101 
107 
112  } PrintScaling;
113 
119  typedef enum {
120  Duplex_Undefined = 0,
121 
126 
131 
136  } Duplex;
137 
148  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetHideToolbar(ViewerPreferencesHandle* handle, BooleanObjectHandle** result);
149 
155  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetHideMenubar(ViewerPreferencesHandle* handle, BooleanObjectHandle** result);
156 
163  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetHideWindowUI(ViewerPreferencesHandle* handle, BooleanObjectHandle** result);
164 
170  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetFitWindow(ViewerPreferencesHandle* handle, BooleanObjectHandle** result);
171 
177  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetCenterWindow(ViewerPreferencesHandle* handle, BooleanObjectHandle** result);
178 
188  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetDisplayDocTitle(ViewerPreferencesHandle* handle, BooleanObjectHandle** result);
189 
194 
198  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetDirection(ViewerPreferencesHandle* handle, ReadingOrder* result);
199 
205  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetViewArea(ViewerPreferencesHandle* handle, NameObjectHandle** result);
206 
212  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetViewClip(ViewerPreferencesHandle* handle, NameObjectHandle** result);
213 
219  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetPrintArea(ViewerPreferencesHandle* handle, NameObjectHandle** result);
220 
226  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetPrintClip(ViewerPreferencesHandle* handle, NameObjectHandle** result);
227 
231  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetPrintScaling(ViewerPreferencesHandle* handle, PrintScaling* result);
232 
236  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetDuplex(ViewerPreferencesHandle* handle, Duplex* result);
237 
243  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetPickTrayByPDFSize(ViewerPreferencesHandle* handle, BooleanObjectHandle** result);
244 
250  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetPrintPageRange(ViewerPreferencesHandle* handle, PageRangeHandle** result);
251 
257  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_GetNumCopies(ViewerPreferencesHandle* handle, IntegerObjectHandle** result);
258 
263  VANILLAPDF_API error_type CALLING_CONVENTION ViewerPreferences_Release(ViewerPreferencesHandle* handle);
264 
275  VANILLAPDF_API error_type CALLING_CONVENTION PageRange_GetSize(PageRangeHandle* handle, size_type* result);
276 
280  VANILLAPDF_API error_type CALLING_CONVENTION PageRange_GetSubrange(PageRangeHandle* handle, size_type at, PageSubRangeHandle** result);
281 
286  VANILLAPDF_API error_type CALLING_CONVENTION PageRange_Release(PageRangeHandle* handle);
287 
298  VANILLAPDF_API error_type CALLING_CONVENTION PageSubRange_GetFirstPage(PageSubRangeHandle* handle, IntegerObjectHandle** result);
299 
303  VANILLAPDF_API error_type CALLING_CONVENTION PageSubRange_GetLastPage(PageSubRangeHandle* handle, IntegerObjectHandle** result);
304 
309  VANILLAPDF_API error_type CALLING_CONVENTION PageSubRange_Release(PageSubRangeHandle* handle);
310 
313 #ifdef __cplusplus
314 };
315 #endif
316 
317 #endif /* _C_VIEWER_PREFERENCES_H */
error_type ViewerPreferences_GetNonFullScreenPageMode(ViewerPreferencesHandle *handle, NonFullScreenPageMode *result)
The document's page mode, specifying how to display the document on exiting full-screen mode...
Neither document outline nor thumbnail images visible.
Definition: c_viewer_preferences.h:57
error_type ViewerPreferences_GetNumCopies(ViewerPreferencesHandle *handle, IntegerObjectHandle **result)
The number of copies that shall be printed when the print dialog is opened for this file...
Duplex and flip on the short edge of the sheet.
Definition: c_viewer_preferences.h:130
error_type PageRange_Release(PageRangeHandle *handle)
Decrement the internal reference counter.
error_type ViewerPreferences_GetHideWindowUI(ViewerPreferencesHandle *handle, BooleanObjectHandle **result)
A flag specifying whether to hide user interface elements in the document's window (such as scroll ba...
error_type PageRange_GetSize(PageRangeHandle *handle, size_type *result)
Get size of the collections.
Controlling the way the document shall be presented on the screen or in print.
PrintScaling
The page scaling option that shall be selected when a print dialog is displayed for this document...
Definition: c_viewer_preferences.h:99
error_type ViewerPreferences_Release(ViewerPreferencesHandle *handle)
Decrement the internal reference counter.
Integer objects represent mathematical integers.
This file contains all type forward declarations returned by the library API.
error_type PageSubRange_GetFirstPage(PageSubRangeHandle *handle, IntegerObjectHandle **result)
Get the index of first last page in the sub-range.
ReadingOrder
The predominant reading order for text.
Definition: c_viewer_preferences.h:78
Indicates the conforming reader's default print scaling.
Definition: c_viewer_preferences.h:106
uint32_t size_type
Size type defined in standard library.
Definition: c_types.h:62
Document outline visible.
Definition: c_viewer_preferences.h:62
Optional content group panel visible.
Definition: c_viewer_preferences.h:72
error_type ViewerPreferences_GetViewArea(ViewerPreferencesHandle *handle, NameObjectHandle **result)
The name of the page boundary representing the area of a page that shall be displayed when viewing th...
Duplex and flip on the long edge of the sheet.
Definition: c_viewer_preferences.h:135
error_type ViewerPreferences_GetDirection(ViewerPreferencesHandle *handle, ReadingOrder *result)
The predominant reading order for text.
error_type ViewerPreferences_GetHideToolbar(ViewerPreferencesHandle *handle, BooleanObjectHandle **result)
A flag specifying whether to hide the conforming reader's tool bars when the document is active...
error_type ViewerPreferences_GetDuplex(ViewerPreferencesHandle *handle, Duplex *result)
The paper handling option that shall be used when printing the file from the print dialog...
error_type ViewerPreferences_GetCenterWindow(ViewerPreferencesHandle *handle, BooleanObjectHandle **result)
A flag specifying whether to position the document's window in the center of the screen.
Boolean objects represent the logical values of true and false.
NonFullScreenPageMode
The document's page mode, specifying how to display the document on exiting full-screen mode...
Definition: c_viewer_preferences.h:51
error_type PageRange_GetSubrange(PageRangeHandle *handle, size_type at, PageSubRangeHandle **result)
Get sub-range at index at.
error_type PageSubRange_GetLastPage(PageSubRangeHandle *handle, IntegerObjectHandle **result)
Get the index of last last page in the sub-range.
uint32_t error_type
This is return value type of all API functions.
Definition: c_types.h:25
This file contains macro declarations for importing and exporting symbols from library boundaries...
error_type ViewerPreferences_GetPrintScaling(ViewerPreferencesHandle *handle, PrintScaling *result)
The page scaling option that shall be selected when a print dialog is displayed for this document...
error_type ViewerPreferences_GetPickTrayByPDFSize(ViewerPreferencesHandle *handle, BooleanObjectHandle **result)
A flag specifying whether the PDF page size shall be used to select the input paper tray...
Specifies first and last page number of defined range.
Right to left (including vertical writing systems, such as Chinese, Japanese, and Korean)...
Definition: c_viewer_preferences.h:91
error_type PageSubRange_Release(PageSubRangeHandle *handle)
Decrement the internal reference counter.
error_type ViewerPreferences_GetDisplayDocTitle(ViewerPreferencesHandle *handle, BooleanObjectHandle **result)
A flag specifying whether the window's title bar should display the document title taken from the Tit...
Collection of PageSubRangeHandle.
Left to right.
Definition: c_viewer_preferences.h:84
Duplex
The paper handling option that shall be used when printing the file from the print dialog...
Definition: c_viewer_preferences.h:119
No page scaling.
Definition: c_viewer_preferences.h:111
This file contains types and constants used as parameters or return values.
Thumbnail images visible.
Definition: c_viewer_preferences.h:67
error_type ViewerPreferences_GetFitWindow(ViewerPreferencesHandle *handle, BooleanObjectHandle **result)
A flag specifying whether to resize the document's window to fit the size of the first displayed page...
error_type ViewerPreferences_GetHideMenubar(ViewerPreferencesHandle *handle, BooleanObjectHandle **result)
A flag specifying whether to hide the conforming reader's menu bar when the document is active...
error_type ViewerPreferences_GetPrintPageRange(ViewerPreferencesHandle *handle, PageRangeHandle **result)
The page numbers used to initialize the print dialog box when the file is printed.
error_type ViewerPreferences_GetPrintClip(ViewerPreferencesHandle *handle, NameObjectHandle **result)
The name of the page boundary to which the contents of a page shall be clipped when printing the docu...
A name object is an atomic symbol uniquely defined by a sequence of characters.
error_type ViewerPreferences_GetViewClip(ViewerPreferencesHandle *handle, NameObjectHandle **result)
The name of the page boundary to which the contents of a page shall be clipped when viewing the docum...
Print single-sided.
Definition: c_viewer_preferences.h:125
error_type ViewerPreferences_GetPrintArea(ViewerPreferencesHandle *handle, NameObjectHandle **result)
The name of the page boundary representing the area of a page that shall be rendered when printing th...