Struct CTParagraphStyle

Source

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

Available on crate feature CTParagraphStyle only.

Expand description

Apple’s documentation

Implementations§

Source §

impl CTParagraphStyle

Source

pub unsafe fn new( settings: *const CTParagraphStyleSetting, setting_count: usize, ) -> CFRetained<CTParagraphStyle>

Creates an immutable paragraph style.

Using this function is the easiest and most efficient way to create a paragraph style. Paragraph styles should be kept immutable for totally lock-free operation.

If an invalid paragraph style setting specifier is passed into the “settings” parameter, nothing bad will happen but just don’t expect to be able to query for this value. This is to allow backwards compatibility with style setting specifiers that may be introduced in future versions.

Parameter settings: The settings that you wish to pre-load the paragraph style with. If you wish to specify the default set of settings, then this parameter may be set to NULL.

Parameter settingCount: The number of settings that you have specified in the “settings” parameter. This must be greater than or equal to zero.

Returns: If the paragraph style creation was successful, this function will return a valid reference to an immutable CTParagraphStyle object. Otherwise, this function will return NULL.

Source

pub unsafe fn copy(self: &CTParagraphStyle) -> CFRetained<CTParagraphStyle>

Creates an immutable copy of a paragraph style.

Parameter paragraphStyle: The style that you wish to copy.

Returns: If the “paragraphStyle” reference is valid, then this function will return valid reference to an immutable CTParagraphStyle object that is a copy of the one passed into “paragraphStyle”.

Source

pub unsafe fn value_for_specifier( self: &CTParagraphStyle, spec: CTParagraphStyleSpecifier, value_buffer_size: usize, value_buffer: NonNull<c_void>, ) -> bool

Obtains the current value for a single setting specifier.

This function will return the current value of the specifier whether or not the user had actually set it. If the user has not set it, this function will return the default value.

If an invalid paragraph style setting specifier is passed into the “spec” parameter, nothing bad will happen and the buffer value will simply be zeroed out. This is to allow backwards compatibility with style setting specifier that may be introduced in future versions.

Parameter paragraphStyle: The paragraph style that you wish to get the value from.

Parameter spec: The setting specifier that you want to get the value for.

Parameter valueBufferSize: The size of the buffer pointed to by the “valueBuffer” parameter. This value must be at least as large as the size the required by the CTParagraphSpecifier value set in the “spec” parameter.

Parameter valueBuffer: The buffer where the requested setting value will be written upon successful completion. The buffer’s size needs to be at least as large as the value passed into “valueBufferSize”.

Returns: This function will return “true” if the valueBuffer had been successfully filled. Otherwise, this function will return false, indicating that one or more of the parameters is not valid.

Methods from Deref<Target = CFType>§

Source

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.

Source

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.