Contents

drawStrikethrough(forGlyphRange:strikethroughType:baselineOffset:lineFragmentRect:lineFragmentGlyphRange:containerOrigin:)

Draws a strikethrough for the specified glyphs.

Declaration

func drawStrikethrough(forGlyphRange glyphRange: NSRange, strikethroughType strikethroughVal: NSUnderlineStyle, baselineOffset: CGFloat, lineFragmentRect lineRect: NSRect, lineFragmentGlyphRange lineGlyphRange: NSRange, containerOrigin: NSPoint)

Parameters

  • glyphRange:

    The range of glyphs for which to draw a strikethrough. The range must belong to a single line fragment rectangle (as returned by Linefragmentrect(forglyphat:effectiverange:)).

  • strikethroughVal:

    The style of strikethrough to draw. This value is a mask derived from the value for Underlinestyle—for example, (NSUnderlinePatternDash | NSUnderlineStyleThick). Subclasses can define custom strikethrough styles.

  • baselineOffset:

    Indicates how far above the text baseline the underline should be drawn.

  • lineRect:

    The line fragment rectangle containing the glyphs to draw strikethrough for.

  • lineGlyphRange:

    The range of all glyphs within lineRect.

  • containerOrigin:

    The origin of the line fragment rectangle’s NSTextContainer in its NSTextView.

Discussion

This method is invoked automatically by strikethroughGlyphRange(_:strikethroughType:lineFragmentRect:lineFragmentGlyphRange:containerOrigin:); you should rarely need to invoke it directly. This method’s strikethroughVal parameter does not take account of any setting forNSUnderlineByWordMask because that’s taken care of by underlineGlyphRange(_:underlineType:lineFragmentRect:lineFragmentGlyphRange:containerOrigin:).

See Also

Drawing