Platforms to show: All Mac Windows Linux Cross-Platform

PDFViewMBS class

Super class: NSViewMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
class PDFKit MBS PDFKit Plugin 9.6 ✅ Yes ❌ No ❌ No ✅ Yes Desktop & iOS
A PDFView object encapsulates the functionality of PDF Kit into a single widget that you can add to your application.

PDFView may be the only class you need to deal with for adding PDF functionality to your application. It lets you display PDF data and allows users to select content, navigate through a document, set zoom level, and copy textual content to the Pasteboard. PDFView also keeps track of page history.

You can subclass PDFView to create a custom PDF viewer or better use our CustomPDFViewMBS class.

You can also create a custom PDF viewer by using the PDF Kit utility classes directly and not using PDFView at all.

You can embed this view in a CustomNSViewMBS to get more events for mouse and keyboard.
Subclass of the NSViewMBS class.

PDF Area Of Interest

Constant Value Description
kPDFAnnotationArea 4 The mouse is over an annotation.
kPDFControlArea 16 The mouse is over a control.
kPDFIconArea 64 The mouse is over an icon.
Available in Mac OS X v10.5 and later.
kPDFImageArea 256 Over an image.
kPDFLinkArea 8 The mouse is over a link.
kPDFNoArea 0 The mouse is over an undefined area.
kPDFPageArea 1 The mouse is over a page.
kPDFPopupArea 128 The mouse is over a popup menu.
kPDFTextArea 2 The mouse is over text.
kPDFTextFieldArea 32 The mouse is over a text field.

Display Directions

Constant Value Description
kPDFDisplayDirectionHorizontal 1 Horizontal
kPDFDisplayDirectionVertical 0 Vertical

Display Mode

Constant Value Description
kPDFDisplaySinglePage 0 The document displays one page at a time horizontally and vertically. Vertical and horizontal scrolling apply only to the current page.
kPDFDisplaySinglePageContinuous 1 he document displays in continuous mode vertically, with single-page width horizontally. Vertical scrolling applies to the entire document.
kPDFDisplayTwoUp 2 The document displays two pages side-by-side. Vertical and horizontal scrolling apply only to the pair of displayed pages.
kPDFDisplayTwoUpContinuous 3 The document displays in continuous mode vertically and displays two pages side-by-side horizontally. Vertical scrolling applies to the entire document.

Interpolation Quality Constants

Constant Value Description
kPDFInterpolationQualityHigh 2 high
kPDFInterpolationQualityLow 1 low
kPDFInterpolationQualityNone 0

Super class NSViewMBS

Constants

Constant Value Description
NSBezelBorder 2 One of the constants to specify the type of a view's border. A concave border that makes the view look sunken.
NSFocusRingTypeDefault 0 One of the constants for the focusringtype property. The default focus ring type for NSView or NSCell.
NSFocusRingTypeExterior 2 One of the constants for the focusringtype property. The standard Aqua focus ring.
NSFocusRingTypeNone 1 One of the constants for the focusringtype property. No focus ring. If you set the focus ring type to this value, NSView and NSCell will not draw any focus ring.
NSGrooveBorder 3 One of the constants to specify the type of a view's border. A thin border that looks etched around the image.
NSLineBorder 1 One of the constants to specify the type of a view's border. A black line border around the view.
NSNoBorder 0 One of the constants to specify the type of a view's border. No border.
NSViewHeightSizable 16 One of the constants for the autoresizingMask property. The receiver's height is flexible.
NSViewLayerContentsRedrawBeforeViewResize 3 One of the view layer content redraw policy constants.
NSViewLayerContentsRedrawDuringViewResize 2 One of the view layer content redraw policy constants.
NSViewLayerContentsRedrawNever 0 One of the view layer content redraw policy constants.
NSViewLayerContentsRedrawOnSetNeedsDisplay 1 One of the view layer content redraw policy constants.
NSViewMaxXMargin 4 One of the constants for the autoresizingMask property. The right margin between the receiver and its superview is flexible.
NSViewMaxYMargin 32 One of the constants for the autoresizingMask property. The top margin between the receiver and its superview is flexible.
NSViewMinXMargin 1 One of the constants for the autoresizingMask property. The left margin between the receiver and its superview is flexible.
NSViewMinYMargin 8 One of the constants for the autoresizingMask property. The bottom margin between the receiver and its superview is flexible.
NSViewNotSizable 0 One of the constants for the autoresizingMask property. The receiver cannot be resized.
NSViewWidthSizable 2 One of the constants for the autoresizingMask property. The receiver's width is flexible.

Window Order Constants

Constant Value Description
NSWindowAbove 1 Moves the window above the indicated window.
NSWindowBelow -1 Moves the window below the indicated window.
NSWindowOut 0 Moves the window off the screen.

Super class NSResponderMBS

Sub classes:

Some properties using for this class:

Some examples using this class:

Blog Entries


The items on this page are in the following plugins: MBS MacBase Plugin, MBS PDFKit Plugin.


PDFThumbnailViewMBS   -   PermissionsMBS


The biggest plugin in space...