Struct CTFramesetter 

pub struct CTFramesetter { /* private fields */ }

Available on crate feature CTFramesetter only.

Apple’s documentation

Implementations

impl CTFramesetter

pub unsafe fn with_typesetter( typesetter: &CTTypesetter, ) -> CFRetained<CTFramesetter>

Available on crate feature CTTypesetter only.

Creates a framesetter directly from a typesetter.

Each framesetter uses a typesetter internally to perform line breaking and other contextual analysis based on the characters in a string. This function allows use of a typesetter that was constructed using specific options.

Parameter typesetter: The typesetter to be used by the newly-created framesetter.

Returns: This function will return a reference to a CTFramesetter object.

See also: CTTypesetterCreateWithAttributedStringAndOptions

pub unsafe fn with_attributed_string( attr_string: &CFAttributedString, ) -> CFRetained<CTFramesetter>

Creates an immutable framesetter object from an attributed string.

The resultant framesetter object can be used to create and fill text frames with the CTFramesetterCreateFrame call.

Parameter attrString: The attributed string to construct the framesetter with.

Returns: This function will return a reference to a CTFramesetter object.

pub unsafe fn frame( &self, string_range: CFRange, path: &CGPath, frame_attributes: Option<&CFDictionary>, ) -> CFRetained<CTFrame>

Available on crate features CTFrame and objc2-core-graphics only.

Creates an immutable frame from a framesetter.

This call will create a frame full of glyphs in the shape of the path provided by the “path” parameter. The framesetter will continue to fill the frame until it either runs out of text or it finds that text no longer fits.

Parameter framesetter: The framesetter that will be used to create the frame.

Parameter stringRange: The string range which the new frame will be based on. The string range is a range over the string that was used to create the framesetter. If the length portion of the range is set to 0, then the framesetter will continue to add lines until it runs out of text or space.

Parameter path: A CGPath object that specifies the shape which the frame will take on.

Parameter frameAttributes: Additional attributes that control the frame filling process can be specified here, or NULL if there are no such attributes. See CTFrame.h for available attributes.

Returns: This function will return a reference to a new CTFrame object.

Safety

frame_attributes generics must be of the correct type.

pub unsafe fn typesetter(&self) -> CFRetained<CTTypesetter>

Available on crate feature CTTypesetter only.

Returns the typesetter object being used by the framesetter.

Each framesetter uses a typesetter internally to perform line breaking and other contextual analysis based on the characters in a string; this function returns the typesetter being used by a particular framesetter if the caller would like to perform other operations on that typesetter.

Parameter framesetter: The framesetter from which a typesetter is being requested.

Returns: This function will return a reference to a CTTypesetter object, which should not be released by the caller.

pub unsafe fn suggest_frame_size_with_constraints( &self, string_range: CFRange, frame_attributes: Option<&CFDictionary>, constraints: CGSize, fit_range: *mut CFRange, ) -> CGSize

Determines the frame size needed for a string range.

This function may be used to determine how much space is needed to display a string, optionally by constraining the space along either dimension.

Parameter framesetter: The framesetter that will be used for measuring the frame size.

Parameter stringRange: The string range to which the frame size will apply. The string range is a range over the string that was used to create the framesetter. If the length portion of the range is set to 0, then the framesetter will continue to add lines until it runs out of text or space.

Parameter frameAttributes: Additional attributes that control the frame filling process can be specified here, or NULL if there are no such attributes.

Parameter constraints: The width and height to which the frame size will be constrained, A value of CGFLOAT_MAX for either dimension indicates that it should be treated as unconstrained.

Parameter fitRange: The range of the string that actually fit in the constrained size.

Returns: The actual dimensions for the given string range and constraints.

Safety

• frame_attributes generics must be of the correct type.
• fit_range must be a valid pointer or null.

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 CTFramesetter

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for CTFramesetter

fn as_ref(&self) -> &CFType

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

impl AsRef<CTFramesetter> for CTFramesetter

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for CTFramesetter

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for CTFramesetter

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for CTFramesetter

fn type_id() -> CFTypeID

Returns the CFType of the framesetter object

impl Debug for CTFramesetter

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

Formats the value using the given formatter.

impl Deref for CTFramesetter

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CTFramesetter

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 CTFramesetter

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for CTFramesetter

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 CTFramesetter

const ENCODING_REF: Encoding

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

impl Type for CTFramesetter

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 CTFramesetter