Struct PDFView

Source

#[repr(C)]
pub struct PDFView { /* private fields */ }

Available on crate feature PDFView and crate feature objc2-app-kit and macOS only.

Expand description

Apple’s documentation

Implementations§

Source §

impl PDFView

Source

pub unsafe fn document(&self) -> Option<Retained<PDFDocument>>

Available on crate feature PDFDocument only.

Source

pub unsafe fn setDocument(&self, document: Option<&PDFDocument>)

Available on crate feature PDFDocument only.

Available on crate feature PDFPage only.

Source

pub unsafe fn setDisplayBox(&self, display_box: PDFDisplayBox)

Available on crate feature PDFPage only.

Setter for autoScales.

Source

pub unsafe fn scaleFactorForSizeToFit(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn areaOfInterestForPoint( &self, cursor_location: NSPoint, ) -> PDFAreaOfInterest

Available on crate feature PDFPage only.

Source

pub unsafe fn setCursorForAreaOfInterest(&self, area: PDFAreaOfInterest)

Available on crate feature PDFPage only.

Source

pub unsafe fn performAction(&self, action: &PDFAction)

Available on crate feature PDFAction only.

Source

pub unsafe fn currentSelection(&self) -> Option<Retained<PDFSelection>>

Available on crate feature PDFSelection only.

Source

pub unsafe fn setCurrentSelection( &self, current_selection: Option<&PDFSelection>, )

Available on crate feature PDFSelection only.

Setter for currentSelection.

Source

pub unsafe fn setCurrentSelection_animate( &self, selection: Option<&PDFSelection>, animate: bool, )

Available on crate feature PDFSelection only.

Source

pub unsafe fn clearSelection(&self)

Source

pub unsafe fn selectAll(&self, sender: Option<&AnyObject>)

Source

pub unsafe fn scrollSelectionToVisible(&self, sender: Option<&AnyObject>)

Source

pub unsafe fn highlightedSelections( &self, ) -> Option<Retained<NSArray<PDFSelection>>>

Available on crate feature PDFSelection only.

Source

pub unsafe fn setHighlightedSelections( &self, highlighted_selections: Option<&NSArray<PDFSelection>>, )

Available on crate feature PDFSelection only.

Setter for highlightedSelections.

Source

pub unsafe fn drawPage_toContext(&self, page: &PDFPage, context: &CGContext)

Available on crate features PDFPage and objc2-core-graphics only.

Source

pub unsafe fn drawPagePost_toContext(&self, page: &PDFPage, context: &CGContext)

Available on crate features PDFPage and objc2-core-graphics only.

Source

pub unsafe fn copy(&self, sender: Option<&AnyObject>)

Source

Available on crate feature PDFPage only.

Source

pub unsafe fn documentView(&self) -> Option<Retained<NSView>>

Source

pub unsafe fn layoutDocumentView(&self)

Source

pub unsafe fn annotationsChangedOnPage(&self, page: &PDFPage)

Available on crate feature PDFPage only.

Source

pub unsafe fn rowSizeForPage(&self, page: &PDFPage) -> NSSize

Available on crate feature PDFPage only.

Source

pub unsafe fn acceptsDraggedFiles(&self) -> bool

Source

pub unsafe fn setAcceptsDraggedFiles(&self, accepts_dragged_files: bool)

Setter for acceptsDraggedFiles.

Source

pub unsafe fn visiblePages(&self) -> Retained<NSArray<PDFPage>>

Available on crate feature PDFPage only.

Source

pub unsafe fn enableDataDetectors(&self) -> bool

👎Deprecated

Source

pub unsafe fn setEnableDataDetectors(&self, enable_data_detectors: bool)

👎Deprecated

👎Deprecated

Source

pub unsafe fn setShouldAntiAlias(&self, should_anti_alias: bool)

👎Deprecated

Setter for shouldAntiAlias.

Source

pub unsafe fn greekingThreshold(&self) -> CGFloat

👎Deprecated

Available on crate feature objc2-core-foundation only.

Source

pub unsafe fn setGreekingThreshold(&self, greeking_threshold: CGFloat)

👎Deprecated

Available on crate feature objc2-core-foundation only.

Setter for greekingThreshold.

Source

pub unsafe fn takeBackgroundColorFrom(&self, sender: &AnyObject)

👎Deprecated

Source

pub unsafe fn allowsDragging(&self) -> bool

👎Deprecated

Source

pub unsafe fn setAllowsDragging(&self, allows_dragging: bool)

👎Deprecated

Setter for allowsDragging.

Methods from Deref<Target = NSView>§

Source

pub unsafe fn superview(&self) -> Option<Retained<NSView>>

Source

pub unsafe fn subviews(&self) -> Retained<NSArray<NSView>>

Source

pub unsafe fn setSubviews(&self, subviews: &NSArray<NSView>)

Setter for subviews.

pub fn setPostsFrameChangedNotifications( &self, posts_frame_changed_notifications: bool, )

Setter for postsFrameChangedNotifications.

Source

pub unsafe fn resizeSubviewsWithOldSize(&self, old_size: CGSize)

Source

Source

pub fn frame(&self) -> CGRect

Source

pub unsafe fn setFrame(&self, frame: CGRect)

Setter for frame.

Setter for bounds.

Setter for canDrawConcurrently.

Source

pub unsafe fn canDraw(&self) -> bool

👎Deprecated: If a view needs display, -drawRect: or -updateLayer will be called automatically when the view is able to draw. To check whether a view is in a window, call -window. To check whether a view is hidden, call -isHiddenOrHasHiddenAncestor.

Source

pub unsafe fn setNeedsDisplayInRect(&self, invalid_rect: CGRect)

Source

pub unsafe fn needsDisplay(&self) -> bool

👎Deprecated: Use NSScrollView to achieve scrolling views.

pub unsafe fn setAcceptsTouchEvents(&self, accepts_touch_events: bool)

👎Deprecated: Use allowedTouchTypes instead

Source

pub unsafe fn canDrawSubviewsIntoLayer(&self) -> bool

Source

pub unsafe fn setCanDrawSubviewsIntoLayer( &self, can_draw_subviews_into_layer: bool, )

Setter for canDrawSubviewsIntoLayer.

Source

pub unsafe fn layoutSubtreeIfNeeded(&self)

Source

A contextual menu is being opened from the receiving view. The view should update any visual state in response — such as making a selection.

Parameter menu: The contextual menu that is being opened on the view

Parameter event: The event that caused the menu to open.

Source

pub unsafe fn didCloseMenu_withEvent( &self, menu: &NSMenu, event: Option<&NSEvent>, )

A contextual menu shown from the receiving view has been closed. This is only called if the menu had been opened and the view previously received -willOpenMenu:withEvent:.The view should update any visual state in response — such as removing a temporary selection.

Parameter menu: The contextual menu that was open on the view

Parameter event: The event that caused the menu to close. This may be nil if there is no specific event that triggered the closing.

Source

pub unsafe fn toolTip(&self) -> Option<Retained<NSString>>

Source

pub unsafe fn setToolTip(&self, tool_tip: Option<&NSString>)

Setter for toolTip.

pub unsafe fn allowsVibrancy(&self) -> bool

Source

pub unsafe fn viewDidChangeEffectiveAppearance(&self)

Override point for reacting to the effective appearance of the receiver changing. At this point effectiveAppearance property reflects the new appearance.

Source

pub unsafe fn nextKeyView(&self) -> Option<Retained<NSView>>

Source

pub unsafe fn setNextKeyView(&self, next_key_view: Option<&NSView>)

Setter for nextKeyView.

Setter for additionalSafeAreaInsets.

👎Deprecated

Methods from Deref<Target = NSResponder>§

Source

pub unsafe fn nextResponder(&self) -> Option<Retained<NSResponder>>

Source

pub unsafe fn setNextResponder(&self, next_responder: Option<&NSResponder>)

Setter for nextResponder.

You should only override this method when you do not want the system-provided default behavior for the context menu hotkey, either for a specific key combination, or for the hotkey in general. For example, if your application already provides a different behavior for control-Return (the default context menu hotkey definition), and you want to preserve that behavior, you should override this method to handle that specific key combination, and then return without calling super. Note that the user may customize the hotkey to a different key combination, so in this example, if any other key combination is passed to your method, you would call super.

An implementation of this method should call [super contextMenuKeyDown:event] to pass the request up the responder chain. If the message reaches the application object, NSApplication’s implementation of this method will send showContextMenuForSelection: to the responder chain. If you do not call super, then no further handling of the key event will be performed.

Note: In some cases, showContextMenuForSelection: will be called without a prior call to contextMenuKeyDown:. This occurs when a view receives an Accessibility ShowMenu action, or when the user has created a Cocoa Text key binding to map a different key combination to the showContextMenuForSelection: action.

Parameter event: The key down event that matches the system-wide context menu hotkey combination.

See also: showContextMenuForSelection:

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

The name of the Objective-C class that this type represents. Read more

Source §

type Super = NSView

The superclass of this class. Read more

Source §

type ThreadKind = <<PDFView as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread. Read more

Source §

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents. Read more

Dereferences the value.

Source §

impl Hash for PDFView

Source §

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

Source §

impl Message for PDFView

Source §

fn retain(&self) -> Retained<Self>
where Self: Sized,

Increment the reference count of the receiver. Read more

Source §

unsafe fn setAppearance(&self, appearance: Option<&NSAppearance>)
where Self: Sized + Message,

Setter for appearance.

fn hash(&self) -> usize
where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure. Read more

Source §

fn isKindOfClass(&self, cls: &AnyClass) -> bool
where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses. Read more

Source §

fn is_kind_of<T>(&self) -> bool
where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Source §

unsafe fn identifier(&self) -> Option<Retained<NSString>>
where Self: Sized + Message,

Source §

unsafe fn setIdentifier(&self, identifier: Option<&NSString>)
where Self: Sized + Message,

Setter for identifier.

Source §

impl PartialEq for PDFView

Source §

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn alloc(mtm: MainThreadMarker) -> Allocated<Self>
where Self: Sized + ClassType,

Allocate a new instance of the class on the main thread. Read more

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

Source §

impl<T, U> TryInto for T
where U: TryFrom<T>,

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Source §

Struct PDFViewCopy item path

Implementations§

impl PDFView

pub unsafe fn document(&self) -> Option<Retained<PDFDocument>>

pub unsafe fn setDocument(&self, document: Option<&PDFDocument>)

pub unsafe fn canGoToFirstPage(&self) -> bool

pub unsafe fn goToFirstPage(&self, sender: Option<&AnyObject>)

pub unsafe fn canGoToLastPage(&self) -> bool

pub unsafe fn goToLastPage(&self, sender: Option<&AnyObject>)

pub unsafe fn canGoToNextPage(&self) -> bool

pub unsafe fn goToNextPage(&self, sender: Option<&AnyObject>)

pub unsafe fn canGoToPreviousPage(&self) -> bool

pub unsafe fn goToPreviousPage(&self, sender: Option<&AnyObject>)

pub unsafe fn canGoBack(&self) -> bool

pub unsafe fn goBack(&self, sender: Option<&AnyObject>)

pub unsafe fn canGoForward(&self) -> bool

pub unsafe fn goForward(&self, sender: Option<&AnyObject>)

pub unsafe fn currentPage(&self) -> Option<Retained<PDFPage>>

pub unsafe fn goToPage(&self, page: &PDFPage)

pub unsafe fn currentDestination(&self) -> Option<Retained<PDFDestination>>

pub unsafe fn goToDestination(&self, destination: &PDFDestination)

pub unsafe fn goToSelection(&self, selection: &PDFSelection)

pub unsafe fn goToRect_onPage(&self, rect: NSRect, page: &PDFPage)

pub unsafe fn displayMode(&self) -> PDFDisplayMode

pub unsafe fn setDisplayMode(&self, display_mode: PDFDisplayMode)

pub unsafe fn displayDirection(&self) -> PDFDisplayDirection

pub unsafe fn setDisplayDirection(&self, display_direction: PDFDisplayDirection)

pub unsafe fn displaysPageBreaks(&self) -> bool

pub unsafe fn setDisplaysPageBreaks(&self, displays_page_breaks: bool)

pub unsafe fn pageBreakMargins(&self) -> NSEdgeInsets

pub unsafe fn setPageBreakMargins(&self, page_break_margins: NSEdgeInsets)

pub unsafe fn displayBox(&self) -> PDFDisplayBox

pub unsafe fn setDisplayBox(&self, display_box: PDFDisplayBox)

pub unsafe fn displaysAsBook(&self) -> bool

pub unsafe fn setDisplaysAsBook(&self, displays_as_book: bool)

pub unsafe fn displaysRTL(&self) -> bool

pub unsafe fn setDisplaysRTL(&self, displays_rtl: bool)

pub unsafe fn backgroundColor(&self) -> Retained<NSColor>

pub unsafe fn setBackgroundColor(&self, background_color: &NSColor)

pub unsafe fn interpolationQuality(&self) -> PDFInterpolationQuality

pub unsafe fn setInterpolationQuality( &self, interpolation_quality: PDFInterpolationQuality, )

pub unsafe fn pageShadowsEnabled(&self) -> bool

pub unsafe fn enablePageShadows(&self, page_shadows_enabled: bool)

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn PDFViewDelegate>>>

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn PDFViewDelegate>>, )

pub unsafe fn pageOverlayViewProvider( &self, ) -> Option<Retained<ProtocolObject<dyn PDFPageOverlayViewProvider>>>

pub unsafe fn setPageOverlayViewProvider( &self, page_overlay_view_provider: Option<&ProtocolObject<dyn PDFPageOverlayViewProvider>>, )

pub unsafe fn scaleFactor(&self) -> CGFloat

pub unsafe fn setScaleFactor(&self, scale_factor: CGFloat)

pub unsafe fn minScaleFactor(&self) -> CGFloat

pub unsafe fn setMinScaleFactor(&self, min_scale_factor: CGFloat)

pub unsafe fn maxScaleFactor(&self) -> CGFloat

pub unsafe fn setMaxScaleFactor(&self, max_scale_factor: CGFloat)

pub unsafe fn autoScales(&self) -> bool

pub unsafe fn setAutoScales(&self, auto_scales: bool)

pub unsafe fn scaleFactorForSizeToFit(&self) -> CGFloat

pub unsafe fn zoomIn(&self, sender: Option<&AnyObject>)

pub unsafe fn canZoomIn(&self) -> bool

pub unsafe fn zoomOut(&self, sender: Option<&AnyObject>)

pub unsafe fn canZoomOut(&self) -> bool

pub unsafe fn areaOfInterestForMouse( &self, event: &NSEvent, ) -> PDFAreaOfInterest

pub unsafe fn areaOfInterestForPoint( &self, cursor_location: NSPoint, ) -> PDFAreaOfInterest

pub unsafe fn setCursorForAreaOfInterest(&self, area: PDFAreaOfInterest)

pub unsafe fn performAction(&self, action: &PDFAction)

pub unsafe fn currentSelection(&self) -> Option<Retained<PDFSelection>>

pub unsafe fn setCurrentSelection( &self, current_selection: Option<&PDFSelection>, )

pub unsafe fn setCurrentSelection_animate( &self, selection: Option<&PDFSelection>, animate: bool, )

pub unsafe fn clearSelection(&self)

pub unsafe fn selectAll(&self, sender: Option<&AnyObject>)

pub unsafe fn scrollSelectionToVisible(&self, sender: Option<&AnyObject>)

pub unsafe fn highlightedSelections( &self, ) -> Option<Retained<NSArray<PDFSelection>>>

pub unsafe fn setHighlightedSelections( &self, highlighted_selections: Option<&NSArray<PDFSelection>>, )

pub unsafe fn drawPage_toContext(&self, page: &PDFPage, context: &CGContext)

pub unsafe fn drawPagePost_toContext(&self, page: &PDFPage, context: &CGContext)

pub unsafe fn copy(&self, sender: Option<&AnyObject>)

pub unsafe fn printWithInfo_autoRotate( &self, print_info: &NSPrintInfo, do_rotate: bool, )

pub unsafe fn printWithInfo_autoRotate_pageScaling( &self, print_info: &NSPrintInfo, do_rotate: bool, scale: PDFPrintScalingMode, )

pub unsafe fn pageForPoint_nearest( &self, point: NSPoint, nearest: bool, ) -> Option<Retained<PDFPage>>

pub unsafe fn convertPoint_toPage( &self, point: NSPoint, page: &PDFPage, ) -> NSPoint

pub unsafe fn convertRect_toPage(&self, rect: NSRect, page: &PDFPage) -> NSRect

Struct PDFView

pub unsafe fn getRectsBeingDrawn_count( &self, rects: mut const CGRect, count: *mut isize, )

pub unsafe fn sortSubviewsUsingFunction_context( &self, compare: unsafe extern "C-unwind" fn(NonNull<NSView>, NonNull<NSView>, mut c_void) -> NSComparisonResult, context: mut c_void, )