< Previous PageNext Page > Hide TOC

Legacy Documentclose button

Important: The information in this document is obsolete and should not be used for new development.

Deprecated NSSimpleHorizontalTypesetter Methods

A method identified as deprecated has been superseded and may become unsupported in the future.

Deprecated in Mac OS X v10.4

sharedInstance

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

+ (id)sharedInstance

Discussion

Returns a shared instance of an NSSimpleHorizontalTypesetter.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

baseOfTypesetterGlyphInfo

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (NSTypesetterGlyphInfo *)baseOfTypesetterGlyphInfo

Discussion

Returns the array of glyph info for the current line fragment. Because the size of the NSTypesetterGlyphInfo data structure could change in the future, you must not access the array elements directly. Instead, use NSGlyphInfoAtIndex to obtain a pointer to the glyph information at a specific index.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

breakLineAtIndex:

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (void)breakLineAtIndex:(unsigned)location

Discussion

Called from layoutGlyphsInHorizontalLineFragment:baseline:, this method breaks the current line fragment at the specified location by setting the current glyph to the first glyph that should appear on the next line.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

capacityOfTypesetterGlyphInfo

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (unsigned)capacityOfTypesetterGlyphInfo

Discussion

Returns the number of elements that the glyph information cache can hold.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

clearAttributesCache

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (void)clearAttributesCache

Discussion

Empties the attributes cache.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

clearGlyphCache

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (void)clearGlyphCache

Discussion

Empties the glyph cache.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

currentContainer

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (NSTextContainer *)currentContainer

Discussion

Returns the container of the text currently being typeset.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

currentLayoutManager

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (NSLayoutManager *)currentLayoutManager

Discussion

Returns the layout manager of the text currently being typeset.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

currentParagraphStyle

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (NSParagraphStyle *)currentParagraphStyle

Discussion

Returns the paragraph style of the text currently being typeset.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

currentTextStorage

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (NSTextStorage *)currentTextStorage

Discussion

Returns the text storage of the text currently being typeset.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

fillAttributesCache

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (void)fillAttributesCache

Discussion

Loads the attributes caches with attributes (such as font name) for the current text attributes.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

firstGlyphIndexOfCurrentLineFragment

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (unsigned)firstGlyphIndexOfCurrentLineFragment

Discussion

Returns the first glyph index of the current line fragment.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

fullJustifyLineAtGlyphIndex:

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (void)fullJustifyLineAtGlyphIndex:(unsigned)glyphIndexForLineBreak

Discussion

Given the glyph index glyphIndexForLineBreak at which the line is broken, fully justifies the line. Called by glyphIndexToBreakLineByWordWrappingAtIndex: when the current text alignment is NSJustifiedTextAlignment.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

glyphIndexToBreakLineByHyphenatingWordAtIndex:

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (unsigned)glyphIndexToBreakLineByHyphenatingWordAtIndex:(unsigned)charIndex

Discussion

Returns the glyph index at which the line should be broken when a word is hyphenated at charIndex. Called by glyphIndexToBreakLineByWordWrappingAtIndex:.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

glyphIndexToBreakLineByWordWrappingAtIndex:

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (unsigned)glyphIndexToBreakLineByWordWrappingAtIndex:(unsigned)charIndex

Discussion

Returns the glyph index at which the line should be broken at charIndex. Called from breakLineAtIndex: when the line break style of the current paragraph style is set to NSLineBreakByWordWrapping.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

growGlyphCaches:fillGlyphInfo:

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (unsigned)growGlyphCaches:(unsigned)desiredCapacity fillGlyphInfo:(BOOL)fillGlyphInfo

Discussion

Grows glyph-related caches to have at least the desiredCapacity. If fillGlyphInfo is YES, also fills with glyph information from the layout manager and updates firstInvalidGlyphIndex. Returns the number of glyphs received.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

insertGlyph:atGlyphIndex:characterIndex:

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (void)insertGlyph:(NSGlyph)glyph atGlyphIndex:(unsigned)glyphIndex characterIndex:(unsigned)charIndex

Discussion

Allows the typesetter to insert a new glyphs into the stream. Inserts glyph into the glyph cache at glyphIndex and maps it to the character at charIndex. The standard typesetter only uses this method for inserting hyphenation glyphs. Because this method keeps the glyph caches in sync, subclasses should always use this method to insert glyphs instead of calling currentLayoutManager directly.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

layoutControlGlyphForLineFragment:

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (NSLayoutStatus)layoutControlGlyphForLineFragment:(NSRect)lineFrag

Discussion

Performs line layout for control characters in lineFrag, which include text attachments, tabs, and returns. Called from layoutGlyphsInHorizontalLineFragment:baseline:.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

layoutGlyphsInHorizontalLineFragment:baseline:

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (NSLayoutStatus)layoutGlyphsInHorizontalLineFragment:(NSRect *)lineFragmentRect baseline:(float *)baseline

Discussion

Lays out a single line horizontally. Called from layoutGlyphsInLayoutManager:startingAtGlyphIndex:maxNumberOfLineFragments:nextGlyphIndex: to perform the core line layout. lineFragmentRect is a rectangle specifying the location and maximum possible size of the line fragment. baseline specifies the baseline of the text; if it contains the value NSBaselineNotSet, this method will determine the baseline itself. baseline may not be NULL. Returns a layout status value indicating the current state of the layout. See “Constants” for the possible return values.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

layoutGlyphsInLayoutManager:startingAtGlyphIndex:maxNumberOfLineFragments:nextGlyphIndex:

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (void)layoutGlyphsInLayoutManager:(NSLayoutManager *)layoutManager startingAtGlyphIndex:(unsigned)startGlyphIndex maxNumberOfLineFragments:(unsigned)maxNumLines nextGlyphIndex:(unsigned *)nextGlyph

Discussion

Lays out glyphs in layoutManager starting at startGlyphIndex. maxNumLines are generated as long as the NSGlyphStorage doesn’t run out of glyphs. nextGlyph will be set to the index of the next glyph that needs to be laid out. Calls layoutGlyphsInHorizontalLineFragment:baseline: once for each line to perform the actual line layout.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

layoutTab

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (void)layoutTab

Discussion

Called within layoutControlGlyphForLineFragment: to lay out a tab character. This method sets the extent of the current glyph to the left side of the tab stop and sets the current glyph offset to the position of the tab stop represented by this character.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

sizeOfTypesetterGlyphInfo

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (unsigned)sizeOfTypesetterGlyphInfo

Discussion

Returns the size of the NSTypesetterGlyphInfo data structure.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

typesetterLaidOneGlyph:

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (void)typesetterLaidOneGlyph:(NSTypesetterGlyphInfo *)glyph

Discussion

Subclasses of NSSimpleHorizontalTypesetter can optionally implement this method. layoutGlyphsInHorizontalLineFragment:baseline: calls this method (if it exists) after laying out a glyph, allowing a subclass to hook into the layout machinery directly.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

updateCurGlyphOffset

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (void)updateCurGlyphOffset

Discussion

Updates the location where the current glyph should be laid out. Note that this value is computed only when it’s needed; this routine will compute it if necessary.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

willSetLineFragmentRect:forGlyphRange:usedRect:

This method has been deprecated. (Deprecated in Mac OS X v10.4.)

- (void)willSetLineFragmentRect:(NSRect *)aRect forGlyphRange:(NSRange)aRange usedRect:(NSRect *)bRect

Discussion

Subclasses of NSSimpleHorizontalTypesetter can optionally implement this method. layoutGlyphsInHorizontalLineFragment:baseline: calls this method (if it exists) after laying out each line fragment, immediately before layoutGlyphsInLayoutManager:startingAtGlyphIndex:maxNumberOfLineFragments:nextGlyphIndex: calls NSLayoutManager’s setLineFragmentRect:forGlyphRange:usedRect: method to record the line fragment rectangles. Subclasses can override this method to globally modify attributes such as line spacing within aRange of glyphs. bRect is expected to be smaller than or equal to aRect.

Availability
Declared In
NSSimpleHorizontalTypesetter.h

< Previous PageNext Page > Hide TOC


© 2006 Apple Computer, Inc. All Rights Reserved. (Last updated: 2006-05-23)


Did this document help you?
Yes: Tell us what works for you.
It’s good, but: Report typos, inaccuracies, and so forth.
It wasn’t helpful: Tell us what would have helped.