Returns insertion points in bulk for a given line fragment.
SDKs
- iOS 7.0+
- macOS 10.5+
- Mac Catalyst 13.0+
- tvOS 9.0+
Frameworks
- UIKit
- App
Kit
Declaration
- (NSUInteger)getLineFragmentInsertionPointsForCharacterAtIndex:(NSUInteger)charIndex alternatePositions:(BOOL)aFlag inDisplayOrder:(BOOL)dFlag positions:(CGFloat *)positions characterIndexes:(NSUInteger *)charIndexes;
Parameters
charIndexThe character index of one character within the line fragment.
aFlagIf
YES, returns alternate, rather than primary, insertion points.dFlagIf
YES, returns insertion points in display, rather than logical, order.positionsOn output, the positions of the insertion points, in the order specified.
charIndexesOn output, the indexes of the characters corresponding to the returned insertion points.
Return Value
The number of insertion points returned.
Discussion
The method allows clients to obtain all insertion points for a line fragment in one call. Each pointer passed in should either be NULL or else point to sufficient memory to hold as many elements as there are insertion points in the line fragment (which cannot be more than the number of characters + 1). The returned positions indicate a transverse offset relative to the line fragment rectangle's origin. Internal caching is used to ensure that repeated calls to this method for the same line fragment (possibly with differing values for other arguments) are not significantly more expensive than a single call.