Struct QLPreviewReply

Source

pub struct QLPreviewReply { /* private fields */ }

Available on crate feature QLPreviewReply only.

Expand description

To provide a data-based preview, you have to return a QLPreviewReply object.

Implementations§

Source §

impl QLPreviewReply

Source

pub unsafe fn stringEncoding(&self) -> NSStringEncoding

String encoding for text or html based previews. Defaults to NSUTF8StringEncoding.

Source

pub unsafe fn setStringEncoding(&self, string_encoding: NSStringEncoding)

Setter for stringEncoding.

Source

pub unsafe fn attachments( &self, ) -> Retained<NSDictionary<NSString, QLPreviewReplyAttachment>>

Attachments for HTML data previews. The keys of the dictionary are the attachment identifiers (eg foo) that can be referenced with the cid:id URL (eg cid:foo).

Source

pub unsafe fn setAttachments( &self, attachments: &NSDictionary<NSString, QLPreviewReplyAttachment>, )

Setter for attachments.

This is copied when set.

Source

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

Custom display title for the preview. If left as the empty string, QuickLook will use the file name.

Source

pub unsafe fn setTitle(&self, title: &NSString)

Setter for title.

This is copied when set.

Source

pub unsafe fn initWithContextSize_isBitmap_drawingBlock( this: Allocated<Self>, context_size: CGSize, is_bitmap: bool, drawing_block: &DynBlock<dyn Fn(NonNull<CGContext>, NonNull<QLPreviewReply>, mut mut NSError) -> Bool>, ) -> Retained<Self>

Available on crate features block2 and objc2-core-foundation and objc2-core-graphics only.

Use this method to provide a preview by drawing into a context.

Parameter contextSize: The size of your image.

Parameter isBitmap: Whether the context should be bitmap or vector.

Parameter drawingBlock: The preview should be drawn into the context passed to this block. The QLPreviewReply passed into this block is the same as the one created by this method and is provided for convenience for any further updates to its properties during the drawing block. Return YES if the preview was successfully drawn into the context. Return NO and populate error otherwise.

Source

pub unsafe fn initWithFileURL( this: Allocated<Self>, file_url: &NSURL, ) -> Retained<Self>

Use this method to provide a preview by providing a URL to a file of a supported type.

Parameter fileURL: A file URL representing a preview of the previewed URL. Currently supported types include: UTTypeImage, UTTypePDF, UTTypeHTML, UTTypeXML, UTTypePlainText, UTTypeRTF, UTTypeRTFD, UTTypeMovie, UTTypeAudio

Source

pub unsafe fn initWithDataOfContentType_contentSize_dataCreationBlock( this: Allocated<Self>, content_type: &UTType, content_size: CGSize, data_creation_block: &DynBlock<dyn Fn(NonNull<QLPreviewReply>, mut mut NSError) -> *mut NSData>, ) -> Retained<Self>

Available on crate features block2 and objc2-core-foundation and objc2-uniform-type-identifiers only.

Use this method to provide a preview with data of a supported format.

Parameter contentType: The content type of the data.

Parameter contentSize: A hint for the size you would like to display your content at. If your content has an intrinsic size built in, such as images and PDFs, that will be used as the final size, but providing the correct size here will allow QuickLook to present loading UI at the correct size before you are finished creating the data. QuickLook will use a default size if NSZeroSize is passed in.

Parameter dataCreationBlock: Create and return data representing the file preview. Supported types include: UTTypeImage, UTTypePDF, UTTypeHTML, UTTypeXML, UTTypePlainText, UTTypeRTF. Heavy lifting should be done inside of the dataCreationBlock instead of when creating the QLPreviewReply. The QLPreviewReply passed into this block is the same as the one created by this method and is provided for convenience for any further updates to its properties, such as attachments, during the data generation. Return the data if successful. Populate error if unsuccessful.

§Safety

data_creation_block block’s return must be a valid pointer or null.

Source §

impl QLPreviewReply

Methods declared on superclass NSObject.

Source

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

Source

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

Source §

impl QLPreviewReply

UI.

Source

pub unsafe fn initForPDFWithPageSize_documentCreationBlock( this: Allocated<Self>, default_page_size: CGSize, document_creation_block: &DynBlock<dyn Fn(NonNull<QLPreviewReply>, mut mut NSError) -> *mut PDFDocument>, ) -> Retained<Self>

Available on crate features block2 and objc2-core-foundation and objc2-pdf-kit only.

Use this method to provide a preview with a PDFDocument

Parameter defaultPageSize: The size of your pages in the document. If the page size varies, use the first page’s size.

Parameter documentCreationBlock: Create and return the PDFDocument. Heavy lifting should be done inside of the documentCreationBlock instead of when creating the QLPreviewReply. The QLPreviewReply passed into this block is the same as the one created by this method and is provided for convenience for any further updates to its properties during document creation. Return the PDFDocument if successfully created. Populate error if unsuccessful.

§Safety

document_creation_block block’s return must be a valid pointer or null.

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