Struct CFMutableAttributedString

#[repr(C)]
pub struct CFMutableAttributedString { /* private fields */ }

Available on crate feature CFAttributedString only.

Apple’s documentation

Implementations

impl CFMutableAttributedString

pub fn new_copy( alloc: Option<&CFAllocator>, max_length: CFIndex, a_str: Option<&CFAttributedString>, ) -> Option<CFRetained<CFMutableAttributedString>>

Creates a mutable attributed string copy. maxLength, if not 0, is a hard bound on the length of the attributed string; exceeding this size limit during any editing operation is a programming error. If 0, there is no limit on the length.

pub fn new( alloc: Option<&CFAllocator>, max_length: CFIndex, ) -> Option<CFRetained<CFMutableAttributedString>>

Creates a mutable empty attributed string. maxLength, if not 0, is a hard bound on the length of the attributed string; exceeding this size limit during any editing operation is a programming error. If 0, there is no limit on the length.

pub unsafe fn replace_string( a_str: Option<&CFMutableAttributedString>, range: CFRange, replacement: Option<&CFString>, )

Modifies the string for the attributed string, much like CFStringReplace(). It’s an error for range to specify characters outside the bounds of aStr.

(Note: This function is a convenience on CFAttributedStringGetMutableString(); however, until CFAttributedStringGetMutableString() is implemented, it remains the only way to edit the string of the attributed string.)

pub fn mutable_string( a_str: Option<&CFMutableAttributedString>, ) -> Option<CFRetained<CFMutableString>>

Gets the string for the attributed string as a mutable string, allowing editing the character contents of the string as if it were an CFMutableString. Attributes corresponding to the edited range are appropriately modified. If, as a result of the edit, new characters are introduced into the string, they inherit the attributes of the first replaced character from range. If no existing characters are replaced by the edit, the new characters inherit the attributes of the character preceding range if it has any, otherwise of the character following range. If the initial string is empty, the attributes for the new characters are also empty.

(Note: This function is not yet implemented and will return NULL except for toll-free bridged instances.)

pub unsafe fn set_attributes( a_str: Option<&CFMutableAttributedString>, range: CFRange, replacement: Option<&CFDictionary>, clear_other_attributes: bool, )

Available on crate feature CFDictionary only.

Sets the value of multiple attributes over the specified range, which should be valid. If clearOtherAttributes is false, existing attributes (which aren’t being replaced) are left alone; otherwise they are cleared. The dictionary should be setup for “usual” CF type usage — CFString keys, and arbitrary CFType values. Note that after this call, further mutations to the replacement dictionary argument by the caller will not affect the contents of the attributed string.

pub unsafe fn set_attribute( a_str: Option<&CFMutableAttributedString>, range: CFRange, attr_name: Option<&CFString>, value: Option<&CFType>, )

Sets the value of a single attribute over the specified range, which should be valid. value should not be NULL.

pub unsafe fn remove_attribute( a_str: Option<&CFMutableAttributedString>, range: CFRange, attr_name: Option<&CFString>, )

Removes the value of a single attribute over the specified range, which should be valid. It’s OK for the attribute not the exist over the specified range.

pub unsafe fn replace_attributed_string( a_str: Option<&CFMutableAttributedString>, range: CFRange, replacement: Option<&CFAttributedString>, )

Replaces the attributed substring over the specified range with the attributed string specified in replacement. range should be valid. To delete a range of the attributed string, call CFAttributedStringReplaceString() with empty string and specified range.

pub fn begin_editing(a_str: Option<&CFMutableAttributedString>)

In cases where attributed string might do a bunch of work to assure self-consistency, CFAttributedStringBeginEditing/CFAttributedStringEndEditing allow disabling that to allow deferring and coalescing any work. It’s a good idea to call these around a set of related mutation calls which don’t require the string to be in consistent state in between. These calls can be nested.

pub fn end_editing(a_str: Option<&CFMutableAttributedString>)

In cases where attributed string might do a bunch of work to assure self-consistency, CFAttributedStringBeginEditing/CFAttributedStringEndEditing allow disabling that to allow deferring and coalescing any work. It’s a good idea to call these around a set of related mutation calls which don’t require the string to be in consistent state in between. These calls can be nested.

Methods from Deref<Target = CFAttributedString>

pub fn string(self: &CFAttributedString) -> Option<CFRetained<CFString>>

Returns the string for the attributed string. For performance reasons, this will often point at the backing store of the attributed string, and it might change if the attributed string is edited. However, this is an implementation detail, and definitely not something that should be counted on.

pub fn length(self: &CFAttributedString) -> CFIndex

Returns the length of the attributed string in characters; same as CFStringGetLength(CFAttributedStringGetString(aStr))

pub unsafe fn attributes( self: &CFAttributedString, loc: CFIndex, effective_range: *mut CFRange, ) -> Option<CFRetained<CFDictionary>>

Available on crate feature CFDictionary only.

Returns the attributes at the specified location. If effectiveRange is not NULL, upon return *effectiveRange contains a range over which the exact same set of attributes apply. Note that for performance reasons, the returned effectiveRange is not necessarily the maximal range - for that, use CFAttributedStringGetAttributesAndLongestEffectiveRange(). It’s a programming error for loc to specify a location outside the bounds of the attributed string.

Note that the returned attribute dictionary might change in unpredictable ways from under the caller if the attributed string is edited after this call. If you wish to hang on to the dictionary long-term, you should make an actual copy of it rather than just retaining it. Also, no assumptions should be made about the relationship of the actual CFDictionaryRef returned by this call and the dictionary originally used to set the attributes, other than the fact that the values stored in the dictionary will be identical (that is, ==) to those originally specified.

pub unsafe fn attribute( self: &CFAttributedString, loc: CFIndex, attr_name: Option<&CFString>, effective_range: *mut CFRange, ) -> Option<CFRetained<CFType>>

Returns the value of a single attribute at the specified location. If the specified attribute doesn’t exist at the location, returns NULL. If effectiveRange is not NULL, upon return *effectiveRange contains a range over which the exact same attribute value applies. Note that for performance reasons, the returned effectiveRange is not necessarily the maximal range - for that, use CFAttributedStringGetAttributeAndLongestEffectiveRange(). It’s a programming error for loc to specify a location outside the bounds of the attributed string.

pub unsafe fn attributes_and_longest_effective_range( self: &CFAttributedString, loc: CFIndex, in_range: CFRange, longest_effective_range: *mut CFRange, ) -> Option<CFRetained<CFDictionary>>

Available on crate feature CFDictionary only.

Returns the attributes at the specified location. If longestEffectiveRange is not NULL, upon return *longestEffectiveRange contains the maximal range within inRange over which the exact same set of attributes apply. The returned range is clipped to inRange. It’s a programming error for loc or inRange to specify locations outside the bounds of the attributed string.

pub unsafe fn attribute_and_longest_effective_range( self: &CFAttributedString, loc: CFIndex, attr_name: Option<&CFString>, in_range: CFRange, longest_effective_range: *mut CFRange, ) -> Option<CFRetained<CFType>>

Returns the value of a single attribute at the specified location. If longestEffectiveRange is not NULL, upon return *longestEffectiveRange contains the maximal range within inRange over which the exact same attribute value applies. The returned range is clipped to inRange. It’s a programming error for loc or inRange to specify locations outside the bounds of the attributed string.

pub unsafe fn bidi_levels_and_resolved_directions( self: &CFAttributedString, range: CFRange, base_direction: i8, bidi_levels: *mut u8, base_directions: *mut u8, ) -> bool

Fills bidiLevels by applying the Unicode Bidi Algorithm (P, X, W, N, and I) to the characters in range. Returns true if the result is not uni-level LTR (in other words, needing further Bidi processing). baseDirection is NSWritingDirection (NSWritingDirectionNatural, NSWritingDirectionLeftToRight, and NSWritingDirectionRightToLeft). Understands NSWritingDirectionAttributeName values.

Methods from Deref<Target = CFType>

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

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 CFMutableAttributedString

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFAttributedString> for CFMutableAttributedString

fn as_ref(&self) -> &CFAttributedString

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

impl AsRef<CFMutableAttributedString> for CFMutableAttributedString

fn as_ref(&self) -> &Self

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

impl AsRef<CFType> for CFMutableAttributedString

fn as_ref(&self) -> &CFType

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

impl Borrow<AnyObject> for CFMutableAttributedString

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFAttributedString> for CFMutableAttributedString

fn borrow(&self) -> &CFAttributedString

Immutably borrows from an owned value.

impl Borrow<CFType> for CFMutableAttributedString

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl Debug for CFMutableAttributedString

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

Formats the value using the given formatter.

impl Deref for CFMutableAttributedString

type Target = CFAttributedString

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CFMutableAttributedString

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 CFMutableAttributedString

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for CFMutableAttributedString

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 CFMutableAttributedString

const ENCODING_REF: Encoding

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

impl Type for CFMutableAttributedString

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 CFMutableAttributedString