Vanilla.PDF  1.3.0
Cross-platform toolkit for creating and modifying PDF documents
List of all members
ViewerPreferencesHandle Class Reference

Controlling the way the document shall be presented on the screen or in print. More...

Inheritance diagram for ViewerPreferencesHandle:
IUnknownHandle
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_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_GetHideWindowUI (ViewerPreferencesHandle *handle, BooleanObjectHandle **result)
 A flag specifying whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.
 
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_GetCenterWindow (ViewerPreferencesHandle *handle, BooleanObjectHandle **result)
 A flag specifying whether to position the document's window in the center of the screen.
 
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 Title entry of the document information dictionary (see 14.3.3, "Document Information Dictionary"). More...
 
error_type ViewerPreferences_GetNonFullScreenPageMode (ViewerPreferencesHandle *handle, NonFullScreenPageMode *result)
 The document's page mode, specifying how to display the document on exiting full-screen mode. More...
 
error_type ViewerPreferences_GetDirection (ViewerPreferencesHandle *handle, ReadingOrder *result)
 The predominant reading order for text. More...
 
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 the document on the screen.
 
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 document on the screen.
 
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 the document.
 
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 document.
 
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. More...
 
error_type ViewerPreferences_GetDuplex (ViewerPreferencesHandle *handle, Duplex *result)
 The paper handling option that shall be used when printing the file from the print dialog. More...
 
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.
 
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_GetNumCopies (ViewerPreferencesHandle *handle, IntegerObjectHandle **result)
 The number of copies that shall be printed when the print dialog is opened for this file.
 
error_type ViewerPreferences_Release (ViewerPreferencesHandle *handle)
 Decrement the internal reference counter. More...
 

Additional Inherited Members

- Public Member Functions inherited from IUnknownHandle
error_type IUnknown_AddRef (IUnknownHandle *handle)
 Increment the internal reference counter.
 

Detailed Description

Controlling the way the document shall be presented on the screen or in print.

See also
CatalogHandle

Friends And Related Function Documentation

◆ ViewerPreferences_GetDisplayDocTitle()

error_type ViewerPreferences_GetDisplayDocTitle ( ViewerPreferencesHandle handle,
BooleanObjectHandle **  result 
)
related

A flag specifying whether the window's title bar should display the document title taken from the Title entry of the document information dictionary (see 14.3.3, "Document Information Dictionary").

If false, the title bar should instead display the name of the PDF file containing the document.

◆ ViewerPreferences_GetNonFullScreenPageMode()

error_type ViewerPreferences_GetNonFullScreenPageMode ( ViewerPreferencesHandle handle,
NonFullScreenPageMode result 
)
related

The document's page mode, specifying how to display the document on exiting full-screen mode.

◆ ViewerPreferences_GetDirection()

error_type ViewerPreferences_GetDirection ( ViewerPreferencesHandle handle,
ReadingOrder result 
)
related

The predominant reading order for text.

◆ ViewerPreferences_GetPrintScaling()

error_type ViewerPreferences_GetPrintScaling ( ViewerPreferencesHandle handle,
PrintScaling result 
)
related

The page scaling option that shall be selected when a print dialog is displayed for this document.

◆ ViewerPreferences_GetDuplex()

error_type ViewerPreferences_GetDuplex ( ViewerPreferencesHandle handle,
Duplex result 
)
related

The paper handling option that shall be used when printing the file from the print dialog.

◆ ViewerPreferences_Release()

error_type ViewerPreferences_Release ( ViewerPreferencesHandle handle)
related

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also
IUnknown_Release

The documentation for this class was generated from the following file: