Struct QLThumbnailRequest 

pub struct QLThumbnailRequest { /* private fields */ }

Available on crate feature QLGenerator only.

This is the type of a reference to Thumbnail requests.

See also Apple’s documentation

Implementations

impl QLThumbnailRequest

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

👎Deprecated: Use a QLFileThumbnailRequest in a Thumbnail Extension to provide thumbnails for your file types.

Returns the url of the file for the thumbnail request.

Parameter thumbnail: The thumbnail request.

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

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

👎Deprecated: Use a QLFileThumbnailRequest in a Thumbnail Extension to provide thumbnails for your file types.

Returns the desired options for the thumbnail request.

Parameter thumbnail: The thumbnail request.

Returns: The desired options for the thumbnail request.

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

👎Deprecated: Use a QLFileThumbnailRequest in a Thumbnail Extension to provide thumbnails for your file types.

Returns the UTI for the thumbnail request.

Parameter thumbnail: The thumbnail request.

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

pub unsafe fn maximum_size(&self) -> CGSize

👎Deprecated: Use a QLFileThumbnailRequest in a Thumbnail Extension to provide thumbnails for your file types.

Returns the maximum desired size (in points) for the thumbnail request.

Parameter thumbnail: The thumbnail request.

Returns: The maximum desired size (in points) for the thumbnail request.

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

👎Deprecated: Use a QLFileThumbnailRequest in a Thumbnail Extension to provide thumbnails for your file types.

Get the thumbnail request generator bundle.

Parameter thumbnail: The thumbnail request.

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

👎Deprecated: Use a QLFileThumbnailRequest in a Thumbnail Extension to provide thumbnails for your file types.

Store some object in thumbnail request.

Parameter thumbnail: The thumbnail 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 QLFileThumbnailRequest in a Thumbnail Extension to provide thumbnails for your file types.

Get the object previously stored with QLThumbnailRequestSetDocumentObject.

Parameter thumbnail: The thumbnail request.

Returns: The object representing the document

pub unsafe fn set_image( &self, image: Option<&CGImage>, properties: Option<&CFDictionary>, )

👎Deprecated: Use a QLThumbnailReply in a Thumbnail Extension to provide thumbnails for your file types

Available on crate feature objc2-core-graphics only.

Sets the thumbnail request response to image.

Parameter thumbnail: The thumbnail request.

Parameter image: The thumbnail image response.

Parameter properties: See possible properties below.

Safety

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

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

👎Deprecated: Use a QLThumbnailReply in a Thumbnail Extension to provide thumbnails for your file types.

Sets the thumbnail request response to image data.

Parameter thumbnail: The thumbnail request.

Parameter data: The thumbnail image response as data. The image format should be supported by ImageIO

Parameter properties: See possible properties below. Additional useful properties: kCGImageSourceTypeIdentifierHint (see ImageIO documentation).

Safety

• data 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 QLThumbnailReply in a Thumbnail Extension to provide thumbnails for your file types.

Available on crate feature objc2-core-graphics only.

Creates a graphic context to draw the thumbnail response in.

Parameter thumbnail: The thumbnail request.

Parameter size: Size in points of the context for the thumbnail response.

Parameter isBitmap: True if thumbnail contents is based on bitmap. size will then be interpreted as pixels, not points.

Parameter properties: See possible properties below.

Returns: A graphic context to draw to.

Once the thumbnail is fully drawn, you should call QLThumbnailRequestFlushContext().

Safety

• 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 QLThumbnailReply in a Thumbnail Extension to provide thumbnails for your file types.

Available on crate feature objc2-core-graphics only.

Flushes the graphic context and creates the thumbnail image response.

Parameter thumbnail: The thumbnail request.

Parameter context: The graphic context created by QLThumbnailRequestCreateContext().

Safety

context might not allow None.

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

👎Deprecated: Use a QLThumbnailReply in a Thumbnail Extension to provide thumbnails for your file types.

Sets the thumbnail request response to the image contained at url.

Parameter thumbnail: The thumbnail request.

Parameter url: The url to the thumbnail image response.

Parameter properties: Currently unused.

Safety

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

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

👎Deprecated: Use a QLThumbnailReply in a Thumbnail Extension to provide thumbnails for your file types.

Sets the thumbnail request response to the image produced by the equivalent preview representation.

Parameter thumbnail: The thumbnail request.

Parameter data: The content data.

Parameter contentTypeUTI: The contentTypeUTI for the preview representation.

Parameter previewProperties: Additional properties for the preview response.

Parameter properties: Currently unused.

Currently supported UTIs are: none. This call only works if your generator is set to be run in the main thread

Safety

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

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

👎Deprecated: Use a QLThumbnailReply in a Thumbnail Extension to provide thumbnails for your file types.

Sets the thumbnail request response to the image produced by the equivalent preview representation.

Parameter thumbnail: The thumbnail 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: none. This call only works if your generator is set to be run in the main thread

Safety

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

pub unsafe fn is_cancelled(&self) -> bool

👎Deprecated: Use a QLFileThumbnailRequest in a Thumbnail Extension to provide thumbnails for your file types.

Returns wether the thumbnail request was cancelled or not.

Parameter thumbnail: The thumbnail request.

Returns: true if the request was cancelled.

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 QLThumbnailRequest

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for QLThumbnailRequest

fn as_ref(&self) -> &CFType

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

impl AsRef<QLThumbnailRequest> for QLThumbnailRequest

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for QLThumbnailRequest

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for QLThumbnailRequest

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for QLThumbnailRequest

fn type_id() -> CFTypeID

Returns the CoreFoundation type ID for QLThumbnailRequests.

impl Debug for QLThumbnailRequest

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

Formats the value using the given formatter.

impl Deref for QLThumbnailRequest

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for QLThumbnailRequest

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 QLThumbnailRequest

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for QLThumbnailRequest

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 QLThumbnailRequest

const ENCODING_REF: Encoding

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

impl Type for QLThumbnailRequest

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 QLThumbnailRequest