Struct PDFView

Source

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.

Available on crate feature PDFPage only.

Source

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

Available on crate feature PDFPage only.

Setter for delegate.

This is a weak property.

Source

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

Available on crate feature PDFPageOverlayViewProvider only.

Source

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

Available on crate feature PDFPageOverlayViewProvider only.

Available on crate feature objc2-core-foundation only.

Setter for maxScaleFactor.

Source

pub unsafe fn autoScales(&self) -> bool

Source

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

Setter for autoScales.

Source

pub unsafe fn scaleFactorForSizeToFit(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

Source

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

§Safety

sender should be of the correct type.

Source

pub unsafe fn canZoomIn(&self) -> bool

Source

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

§Safety

sender should be of the correct type.

Source

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)

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

Available on crate feature PDFSelection only.

Setter for highlightedSelections.

This is copied when set.

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>)

§Safety

sender should be of the correct type.

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)

👎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)

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

pub fn isHidden(&self) -> bool

Source

pub fn setHidden(&self, hidden: bool)

Setter for isHidden.

Source

pub fn isHiddenOrHasHiddenAncestor(&self) -> bool

Source

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

§Safety

rects must be a valid pointer or null.
count must be a valid pointer or null.

§Safety

compare must be implemented correctly.
context must be a valid pointer or null.

pub fn resizeSubviewsWithOldSize(&self, old_size: CGSize)

Source

Source

pub fn frame(&self) -> CGRect

Source

pub fn setFrame(&self, frame: CGRect)

Setter for frame.

Setter for bounds.

Setter for canDrawConcurrently.

Source

pub 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 fn setNeedsDisplayInRect(&self, invalid_rect: CGRect)

Source

pub fn needsDisplay(&self) -> bool

👎Deprecated: Use NSScrollView to achieve scrolling views.

pub fn setAcceptsTouchEvents(&self, accepts_touch_events: bool)

👎Deprecated: Use allowedTouchTypes instead

Source

pub fn canDrawSubviewsIntoLayer(&self) -> bool

Source

pub fn setCanDrawSubviewsIntoLayer(&self, can_draw_subviews_into_layer: bool)

Setter for canDrawSubviewsIntoLayer.

Source

pub 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 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 fn toolTip(&self) -> Option<Retained<NSString>>

Source

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

Setter for toolTip.

This is copied when set.

Source

pub unsafe fn addToolTipRect_owner_userData( &self, rect: CGRect, owner: &AnyObject, data: *mut c_void, ) -> isize

§Safety

owner should be of the correct type.
data must be a valid pointer or null.

Setter for preparedContentRect.

Source

pub fn allowsVibrancy(&self) -> bool

Source

pub 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>>

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

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

Setter for nextKeyView.

Source

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

§Safety

sender should be of the correct type.

Source

pub unsafe fn knowsPageRange(&self, range: *mut NSRange) -> bool

§Safety

range must be a valid pointer.

§Safety

options generic should be of the correct type.

Setter for additionalSafeAreaInsets.

Source

pub fn safeAreaRect(&self) -> CGRect

Source

pub fn prefersCompactControlSizeMetrics(&self) -> bool

When this property is true, any NSControls in the view or its descendants will be sized with compact metrics compatible with macOS 15 and earlier. Defaults to false

Source

pub fn setPrefersCompactControlSizeMetrics( &self, prefers_compact_control_size_metrics: bool, )

Setter for prefersCompactControlSizeMetrics.

Source

pub fn dragFile_fromRect_slideBack_event( &self, filename: &NSString, rect: CGRect, flag: bool, event: &NSEvent, ) -> bool

👎Deprecated: Use -beginDraggingSessionWithItems:event:source: instead

Source

👎Deprecated

Source

pub fn renewGState(&self)

👎Deprecated

Methods from Deref<Target = NSResponder>§

Source

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

§Safety

This is not retained internally, you must ensure the object is still alive.

Source

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

Setter for nextResponder.

§Safety

This is unretained, you must ensure the object is kept alive while in use.

Source

pub unsafe fn tryToPerform_with( &self, action: Sel, object: Option<&AnyObject>, ) -> bool

§Safety

action must be a valid selector.
object should be of the correct type.

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:

Source

pub unsafe fn noResponderFor(&self, event_selector: Sel)

§Safety

event_selector must be a valid selector.

Setter for menu.

Source

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

§Safety

sender should be of the correct type.

Source

pub fn helpRequested(&self, event_ptr: &NSEvent)

Source

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

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`
    }
}