Struct PDFDocument 

pub struct PDFDocument { /* private fields */ }

Available on crate feature PDFDocument only.

Apple’s documentation

Implementations

impl PDFDocument

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn initWithURL( this: Allocated<Self>, url: &NSURL, ) -> Option<Retained<Self>>

pub unsafe fn initWithData( this: Allocated<Self>, data: &NSData, ) -> Option<Retained<Self>>

pub unsafe fn documentURL(&self) -> Option<Retained<NSURL>>

pub unsafe fn documentRef(&self) -> Option<Retained<CGPDFDocument>>

Available on crate feature objc2-core-graphics only.

pub unsafe fn documentAttributes(&self) -> Option<Retained<NSDictionary>>

pub unsafe fn setDocumentAttributes( &self, document_attributes: Option<&NSDictionary>, )

Setter for documentAttributes.

This is copied when set.

Safety

document_attributes generic should be of the correct type.

pub unsafe fn majorVersion(&self) -> NSInteger

pub unsafe fn minorVersion(&self) -> NSInteger

pub unsafe fn isEncrypted(&self) -> bool

pub unsafe fn isLocked(&self) -> bool

pub unsafe fn unlockWithPassword(&self, password: &NSString) -> bool

pub unsafe fn allowsPrinting(&self) -> bool

pub unsafe fn allowsCopying(&self) -> bool

pub unsafe fn allowsDocumentChanges(&self) -> bool

pub unsafe fn allowsDocumentAssembly(&self) -> bool

pub unsafe fn allowsContentAccessibility(&self) -> bool

pub unsafe fn allowsCommenting(&self) -> bool

pub unsafe fn allowsFormFieldEntry(&self) -> bool

pub unsafe fn accessPermissions(&self) -> PDFAccessPermissions

pub unsafe fn permissionsStatus(&self) -> PDFDocumentPermissions

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

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

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

Setter for delegate.

This is a weak property.

pub unsafe fn dataRepresentation(&self) -> Option<Retained<NSData>>

pub unsafe fn dataRepresentationWithOptions( &self, options: &NSDictionary, ) -> Option<Retained<NSData>>

Safety

options generic should be of the correct type.

pub unsafe fn writeToFile(&self, path: &NSString) -> bool

pub unsafe fn writeToFile_withOptions( &self, path: &NSString, options: Option<&NSDictionary<PDFDocumentWriteOption, AnyObject>>, ) -> bool

Safety

options generic should be of the correct type.

pub unsafe fn writeToURL(&self, url: &NSURL) -> bool

pub unsafe fn writeToURL_withOptions( &self, url: &NSURL, options: Option<&NSDictionary<PDFDocumentWriteOption, AnyObject>>, ) -> bool

Safety

options generic should be of the correct type.

pub unsafe fn outlineRoot(&self) -> Option<Retained<PDFOutline>>

Available on crate feature PDFOutline only.

pub unsafe fn setOutlineRoot(&self, outline_root: Option<&PDFOutline>)

Available on crate feature PDFOutline only.

Setter for outlineRoot.

pub unsafe fn outlineItemForSelection( &self, selection: &PDFSelection, ) -> Option<Retained<PDFOutline>>

Available on crate features PDFOutline and PDFSelection only.

pub unsafe fn pageCount(&self) -> NSUInteger

pub unsafe fn pageAtIndex(&self, index: NSUInteger) -> Option<Retained<PDFPage>>

Available on crate feature PDFPage only.

pub unsafe fn indexForPage(&self, page: &PDFPage) -> NSUInteger

Available on crate feature PDFPage only.

pub unsafe fn insertPage_atIndex(&self, page: &PDFPage, index: NSUInteger)

Available on crate feature PDFPage only.

pub unsafe fn removePageAtIndex(&self, index: NSUInteger)

pub unsafe fn exchangePageAtIndex_withPageAtIndex( &self, index_a: NSUInteger, index_b: NSUInteger, )

pub unsafe fn pageClass(&self) -> &'static AnyClass

pub unsafe fn findString_withOptions( &self, string: &NSString, options: NSStringCompareOptions, ) -> Retained<NSArray<PDFSelection>>

Available on crate feature PDFSelection only.

pub unsafe fn beginFindString_withOptions( &self, string: &NSString, options: NSStringCompareOptions, )

pub unsafe fn beginFindStrings_withOptions( &self, strings: &NSArray<NSString>, options: NSStringCompareOptions, )

pub unsafe fn findString_fromSelection_withOptions( &self, string: &NSString, selection: Option<&PDFSelection>, options: NSStringCompareOptions, ) -> Option<Retained<PDFSelection>>

Available on crate feature PDFSelection only.

pub unsafe fn isFinding(&self) -> bool

pub unsafe fn cancelFindString(&self)

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

Available on crate feature PDFSelection only.

pub unsafe fn selectionFromPage_atPoint_toPage_atPoint( &self, start_page: &PDFPage, start_point: NSPoint, end_page: &PDFPage, end_point: NSPoint, ) -> Option<Retained<PDFSelection>>

Available on crate features PDFPage and PDFSelection only.

pub unsafe fn selectionFromPage_atPoint_toPage_atPoint_withGranularity( &self, start_page: &PDFPage, start_point: NSPoint, end_page: &PDFPage, end_point: NSPoint, granularity: PDFSelectionGranularity, ) -> Option<Retained<PDFSelection>>

Available on crate features PDFPage and PDFSelection only.

pub unsafe fn selectionFromPage_atCharacterIndex_toPage_atCharacterIndex( &self, start_page: &PDFPage, start_character: NSUInteger, end_page: &PDFPage, end_character: NSUInteger, ) -> Option<Retained<PDFSelection>>

Available on crate features PDFPage and PDFSelection only.

impl PDFDocument

Methods declared on superclass NSObject.

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

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

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.

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

Trait Implementations

impl AsRef<AnyObject> for PDFDocument

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for PDFDocument

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<PDFDocument> for PDFDocument

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for PDFDocument

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for PDFDocument

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for PDFDocument

const NAME: &'static str = "PDFDocument"

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

type Super = NSObject

The superclass of this class.

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

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

fn class() -> &'static AnyClass

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

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for PDFDocument

type Result = PDFDocument

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for PDFDocument

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for PDFDocument

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for PDFDocument

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for PDFDocument

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for PDFDocument

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for PDFDocument

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

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

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.

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

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

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for PDFDocument

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

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

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for PDFDocument

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for PDFDocument

impl Eq for PDFDocument