Struct QLPreviewRequest 

pub struct QLPreviewRequest { /* private fields */ }

Available on crate feature QLGenerator only.

This is the type of a reference to Preview requests.

See also Apple’s documentation

Implementations

impl QLPreviewRequest

pub unsafe fn url(&self) -> Option<CFRetained<CFURL>>

👎Deprecated: Use a QLPreviewingController in a Preview Extension to provide previews for your file types.

Returns the url of the file for the preview request.

Parameter preview: The preview request.

Returns: The url of the file for the preview request.

pub unsafe fn options(&self) -> Option<CFRetained<CFDictionary>>

👎Deprecated: Use a QLPreviewingController in a Preview Extension to provide previews for your file types.

Returns the desired options for the preview request.

Parameter preview: The preview request.

Returns: The desired options for the preview request.

pub unsafe fn content_uti(&self) -> Option<CFRetained<CFString>>

👎Deprecated: Use a QLPreviewingController in a Preview Extension to provide previews for your file types.

Returns the UTI for the preview request.

Parameter preview: The preview request.

Returns: The UTI of the content being previewed, NULL if not available.

pub unsafe fn generator_bundle(&self) -> Option<CFRetained<CFBundle>>

👎Deprecated: Use a QLPreviewingController in a Preview Extension to provide previews for your file types.

Gets the preview request generator bundle.

Parameter preview: The preview request.

pub unsafe fn set_document_object( &self, object: *const c_void, callbacks: *const CFArrayCallBacks, )

👎Deprecated: Use a QLPreviewingController in a Preview Extension to provide previews for your file types.

Store some object in preview request.

Parameter preview: The preview request.

Parameter object: The object representing the document

Parameter callbacks: Callbacks to retain/release/etc. the object.

You can only call this function once per request.

Safety

• object must be a valid pointer.
• callbacks must be a valid pointer.

pub unsafe fn document_object(&self) -> *const c_void

👎Deprecated: Use a QLPreviewingController in a Preview Extension to provide previews for your file types.

Get the object previously stored with QLPreviewRequestSetDocumentObject.

Parameter preview: The preview request.

Returns: The object representing the document

pub unsafe fn is_cancelled(&self) -> bool

👎Deprecated: Use a QLPreviewingController in a Preview Extension to provide previews for your file types.

Returns wether the preview request was cancelled or not.

Parameter preview: The preview request.

Returns: true if the request was cancelled.

pub unsafe fn set_data_representation( &self, data: Option<&CFData>, content_type_uti: Option<&CFString>, properties: Option<&CFDictionary>, )

👎Deprecated: Use a QLPreviewingController in a Preview Extension to provide previews for your file types.

Sets the preview response with the provided data.

Parameter preview: The preview request.

Parameter data: The content data.

Parameter contentTypeUTI: The contentTypeUTI for the preview representation.

Parameter properties: Additional properties for the preview response.

Currently supported UTIs are: kUTTypeImage, kUTTypePDF, kUTTypeHTML, kUTTypeXML, kUTTypePlainText, kUTTypeRTF, kUTTypeMovie, kUTTypeAudio, and “org.khronos.collada.digital-asset-exchange” (from OSX 10.9)

Safety

• data might not allow None.
• content_type_uti might not allow None.
• properties generics must be of the correct type.
• properties might not allow None.

pub unsafe fn set_url_representation( &self, url: Option<&CFURL>, content_type_uti: Option<&CFString>, properties: Option<&CFDictionary>, )

👎Deprecated: Use a QLPreviewingController in a Preview Extension to provide previews for your file types.

Sets the preview request response with contents at url.

Parameter preview: The preview request.

Parameter url: The url to the preview response.

Parameter contentTypeUTI: The contentTypeUTI for the preview representation.

Parameter properties: Additional properties for the preview response.

Currently supported UTIs are: kUTTypeImage, kUTTypePDF, kUTTypeHTML, kUTTypeXML, kUTTypePlainText, kUTTypeRTF, kUTTypeRTFD, kUTTypeMovie, kUTTypeAudio, and “org.khronos.collada.digital-asset-exchange” (from OSX 10.9)

Safety

• url might not allow None.
• content_type_uti might not allow None.
• properties generics must be of the correct type.
• properties might not allow None.

pub unsafe fn context( &self, size: CGSize, is_bitmap: bool, properties: Option<&CFDictionary>, ) -> Option<CFRetained<CGContext>>

👎Deprecated: Use a QLPreviewingController in a Preview Extension to provide previews for your file types.

Available on crate feature objc2-core-graphics only.

Creates a context to draw the preview in. Context should be flushed with QLPreviewRequestFlushContext()

Parameter preview: The preview request.

Parameter size: The size of the context.

Parameter isBitmap: true if preview is bitmap-based.

Parameter properties: Additional properties for the preview response.

Safety

• properties generics must be of the correct type.
• properties might not allow None.

pub unsafe fn pdf_context( &self, media_box: *const CGRect, auxiliary_info: Option<&CFDictionary>, properties: Option<&CFDictionary>, ) -> Option<CFRetained<CGContext>>

👎Deprecated: Use a QLPreviewingController in a Preview Extension to provide previews for your file types.

Available on crate feature objc2-core-graphics only.

Creates a PDF context to draw the preview in, likely to be multi-pages. Context should be flushed with QLPreviewRequestFlushContext()

Parameter preview: The preview request.

Parameter mediaBox: The media box of the context. see CGPDFContextCreate().

Parameter auxiliaryInfo: The PDF auxiliary info. see CGPDFContextCreate().

Parameter properties: Additional properties for the preview response.

Safety

• media_box must be a valid pointer.
• auxiliary_info generics must be of the correct type.
• auxiliary_info might not allow None.
• properties generics must be of the correct type.
• properties might not allow None.

pub unsafe fn flush_context(&self, context: Option<&CGContext>)

👎Deprecated: Use a QLPreviewingController in a Preview Extension to provide previews for your file types.

Available on crate feature objc2-core-graphics only.

Flush the context and sets the preview response.

Parameter preview: The preview request.

Parameter context: context previously created by QLPreviewRequestCreateContext() or QLPreviewRequestCreatePDFContext().

Safety

context might not allow None.

Methods from Deref<Target = CFType>

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: ConcreteType,

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

pub fn retain_count(&self) -> usize

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations

impl AsRef<AnyObject> for QLPreviewRequest

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for QLPreviewRequest

fn as_ref(&self) -> &CFType

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

impl AsRef<QLPreviewRequest> for QLPreviewRequest

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for QLPreviewRequest

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for QLPreviewRequest

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for QLPreviewRequest

fn type_id() -> CFTypeID

Returns the CoreFoundation type ID for QLPreviewRequests.

impl Debug for QLPreviewRequest

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

Formats the value using the given formatter.

impl Deref for QLPreviewRequest

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for QLPreviewRequest

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 QLPreviewRequest

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for QLPreviewRequest

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 QLPreviewRequest

const ENCODING_REF: Encoding

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

impl Type for QLPreviewRequest

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

where Self: Sized,

Increment the reference count of the receiver.

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated: this is redundant

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::retain

Helper for easier transition from the core-foundation crate.

fn as_CFTypeRef(&self) -> &CFType

where Self: AsRef<CFType>,

👎Deprecated: this is redundant (CF types deref to CFType)

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::from_raw

Helper for easier transition from the core-foundation crate.

impl Eq for QLPreviewRequest