libs-gui/Documentation/gsdoc/NSLayoutManager.html
Adam Fedor d47e202fbe Markup for autogsdoc
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@11788 72102866-910b-0410-8b05-ffd578937521
2001-12-17 16:51:51 +00:00

544 lines
19 KiB
HTML

<html>
<head>
<title>NSLayoutManager</title>
</head>
<body>
<h1>NSLayoutManager</h1>
<h3>Authors</h3>
<dl>
<dt>Jonathan Gapen(<a href="mailto:jagapen@smithlab.chem.wisc.edu"><code>
jagapen@smithlab.chem.wisc.edu
</code></a>)</dt>
<dd>
</dd>
<dt>Michael Hanni(<a href="mailto:mhanni@sprintmail.com"><code>
mhanni@sprintmail.com
</code></a>)</dt>
<dd>
</dd>
</dl>
<blockquote>
The text layout manager class </blockquote>
<p>Copyright: (C) 1999 Free Software Foundation, Inc.</p>
<h1>
Software documentation for the NSLayoutManager class
</h1>
<h2><a name="class$NSLayoutManager">NSLayoutManager</a> : NSObject</h2>
Declared: AppKit/NSLayoutManager.h<br />
<p>
</p>
<h3>addTextContainer:</a></h3>
- (void) <b>addTextContainer:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)obj;<br />
<p>
</p>
<hr />
<h3>backgroundLayoutEnabled</a></h3>
- (BOOL) <b>backgroundLayoutEnabled</b>;<br />
<p>
</p>
<hr />
<h3>boundingRectForGlyphRange:inTextContainer:</a></h3>
- (NSRect) <b>boundingRectForGlyphRange:</b> (NSRange)glyphRange<b> inTextContainer:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)aTextContainer;<br />
<p>
</p>
<hr />
<h3>characterIndexForGlyphAtIndex:</a></h3>
- (unsigned) <b>characterIndexForGlyphAtIndex:</b> (unsigned)glyphIndex;<br />
<p>
</p>
<hr />
<h3>characterRangeForGlyphRange:actualGlyphRange:</a></h3>
- (NSRange) <b>characterRangeForGlyphRange:</b> (NSRange)glyphRange<b> actualGlyphRange:</b> (NSRange*)actualGlyphRange;<br />
<p>
</p>
<hr />
<h3>delegate</a></h3>
- (id) <b>delegate</b>;<br />
<p>
</p>
<hr />
<h3>deleteGlyphsInRange:</a></h3>
- (void) <b>deleteGlyphsInRange:</b> (NSRange)aRange;<br />
<p>
</p>
<hr />
<h3>drawsOutsideLineFragmentForGlyphAtIndex:</a></h3>
- (BOOL) <b>drawsOutsideLineFragmentForGlyphAtIndex:</b> (unsigned)glyphIndex;<br />
<p>
</p>
<hr />
<h3>extraLineFragmentRect</a></h3>
- (NSRect) <b>extraLineFragmentRect</b>;<br />
<p>
</p>
<hr />
<h3>extraLineFragmentTextContainer</a></h3>
- (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*) <b>extraLineFragmentTextContainer</b>;<br />
<p>
</p>
<hr />
<h3>extraLineFragmentUsedRect</a></h3>
- (NSRect) <b>extraLineFragmentUsedRect</b>;<br />
<p>
</p>
<hr />
<h3>firstUnlaidCharacterIndex</a></h3>
- (unsigned) <b>firstUnlaidCharacterIndex</b>;<br />
<p>
</p>
<hr />
<h3>firstUnlaidGlyphIndex</a></h3>
- (unsigned) <b>firstUnlaidGlyphIndex</b>;<br />
<p>
</p>
<hr />
<h3>getFirstUnlaidCharacterIndex:glyphIndex:</a></h3>
- (void) <b>getFirstUnlaidCharacterIndex:</b> (unsigned*)charIndex<b> glyphIndex:</b> (unsigned*)glyphIndex;<br />
<p>
</p>
<hr />
<h3>getGlyphs:range:</a></h3>
- (unsigned) <b>getGlyphs:</b> (NSGlyph*)glyphArray<b> range:</b> (NSRange)glyphRange;<br />
<p>
</p>
<hr />
<h3>glyphAtIndex:</a></h3>
- (NSGlyph) <b>glyphAtIndex:</b> (unsigned)index;<br />
<p>
</p>
<hr />
<h3>glyphAtIndex:isValidIndex:</a></h3>
- (NSGlyph) <b>glyphAtIndex:</b> (unsigned)index<b> isValidIndex:</b> (BOOL*)flag;<br />
<p>
</p>
<hr />
<h3>glyphIndexForPoint:inTextContainer:</a></h3>
- (unsigned) <b>glyphIndexForPoint:</b> (NSPoint)aPoint<b> inTextContainer:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)aTextContainer;<br />
<p>
</p>
<hr />
<h3>glyphIndexForPoint:inTextContainer:fractionOfDistanceThroughGlyph:</a></h3>
- (unsigned) <b>glyphIndexForPoint:</b> (NSPoint)aPoint<b> inTextContainer:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)aTextContainer<b> fractionOfDistanceThroughGlyph:</b> (float*)partialFraction;<br />
<p>
</p>
<hr />
<h3>glyphRangeForBoundingRect:inTextContainer:</a></h3>
- (NSRange) <b>glyphRangeForBoundingRect:</b> (NSRect)aRect<b> inTextContainer:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)aTextContainer;<br />
<p>
</p>
<hr />
<h3>glyphRangeForBoundingRectWithoutAdditionalLayout:inTextContainer:</a></h3>
- (NSRange) <b>glyphRangeForBoundingRectWithoutAdditionalLayout:</b> (NSRect)bounds<b> inTextContainer:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)aTextContainer;<br />
<p>
</p>
<hr />
<h3>glyphRangeForCharacterRange:actualCharacterRange:</a></h3>
- (NSRange) <b>glyphRangeForCharacterRange:</b> (NSRange)charRange<b> actualCharacterRange:</b> (NSRange*)actualCharRange;<br />
<p>
</p>
<hr />
<h3>glyphRangeForTextContainer:</a></h3>
- (NSRange) <b>glyphRangeForTextContainer:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)aTextContainer;<br />
<p>
</p>
<hr />
<h3>init</a></h3>
- (id) <b>init</b>;<br />
<p>
</p>
<hr />
<h3>insertGlyph:atGlyphIndex:characterIndex:</a></h3>
- (void) <b>insertGlyph:</b> (NSGlyph)aGlyph<b> atGlyphIndex:</b> (unsigned)glyphIndex<b> characterIndex:</b> (unsigned)charIndex;<br />
<p>
</p>
<hr />
<h3>insertTextContainer:atIndex:</a></h3>
- (void) <b>insertTextContainer:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)aTextContainer<b> atIndex:</b> (unsigned)index;<br />
<p>
</p>
<hr />
<h3>intAttribute:forGlyphAtIndex:</a></h3>
- (int) <b>intAttribute:</b> (int)attribute<b> forGlyphAtIndex:</b> (unsigned)glyphIndex;<br />
<p>
</p>
<hr />
<h3>invalidateDisplayForCharacterRange:</a></h3>
- (void) <b>invalidateDisplayForCharacterRange:</b> (NSRange)aRange;<br />
<p>
</p>
<hr />
<h3>invalidateDisplayForGlyphRange:</a></h3>
- (void) <b>invalidateDisplayForGlyphRange:</b> (NSRange)aRange;<br />
<p>
</p>
<hr />
<h3>invalidateGlyphsForCharacterRange:changeInLength:actualCharacterRange:</a></h3>
- (void) <b>invalidateGlyphsForCharacterRange:</b> (NSRange)aRange<b> changeInLength:</b> (int)lengthChange<b> actualCharacterRange:</b> (NSRange*)actualRange;<br />
<p>
</p>
<hr />
<h3>invalidateLayoutForCharacterRange:isSoft:actualCharacterRange:</a></h3>
- (void) <b>invalidateLayoutForCharacterRange:</b> (NSRange)aRange<b> isSoft:</b> (BOOL)flag<b> actualCharacterRange:</b> (NSRange*)actualRange;<br />
<p>
</p>
<hr />
<h3>lineFragmentRectForGlyphAtIndex:effectiveRange:</a></h3>
- (NSRect) <b>lineFragmentRectForGlyphAtIndex:</b> (unsigned)glyphIndex<b> effectiveRange:</b> (NSRange*)lineFragmentRange;<br />
<p>
</p>
<hr />
<h3>lineFragmentUsedRectForGlyphAtIndex:effectiveRange:</a></h3>
- (NSRect) <b>lineFragmentUsedRectForGlyphAtIndex:</b> (unsigned)glyphIndex<b> effectiveRange:</b> (NSRange*)lineFragmentRange;<br />
<p>
</p>
<hr />
<h3>locationForGlyphAtIndex:</a></h3>
- (NSPoint) <b>locationForGlyphAtIndex:</b> (unsigned)glyphIndex;<br />
<p>
</p>
<hr />
<h3>notShownAttributeForGlyphAtIndex:</a></h3>
- (BOOL) <b>notShownAttributeForGlyphAtIndex:</b> (unsigned)glyphIndex;<br />
<p>
</p>
<hr />
<h3>numberOfGlyphs</a></h3>
- (unsigned) <b>numberOfGlyphs</b>;<br />
<p>
</p>
<hr />
<h3>rangeOfNominallySpacedGlyphsContainingIndex:</a></h3>
- (NSRange) <b>rangeOfNominallySpacedGlyphsContainingIndex:</b> (unsigned)glyphIndex;<br />
<p>
</p>
<hr />
<h3>rectArrayForCharacterRange:withinSelectedCharacterRange:inTextContainer:rectCount:</a></h3>
- (NSRect*) <b>rectArrayForCharacterRange:</b> (NSRange)charRange<b> withinSelectedCharacterRange:</b> (NSRange)selChareRange<b> inTextContainer:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)aTextContainer<b> rectCount:</b> (unsigned*)rectCount;<br />
<p>
</p>
<hr />
<h3>rectArrayForGlyphRange:withinSelectedGlyphRange:inTextContainer:rectCount:</a></h3>
- (NSRect*) <b>rectArrayForGlyphRange:</b> (NSRange)glyphRange<b> withinSelectedGlyphRange:</b> (NSRange)selectedGlyphRange<b> inTextContainer:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)aTextContainer<b> rectCount:</b> (unsigned*)rectCount;<br />
<p>
</p>
<hr />
<h3>removeTextContainerAtIndex:</a></h3>
- (void) <b>removeTextContainerAtIndex:</b> (unsigned)index;<br />
<p>
</p>
<hr />
<h3>replaceGlyphAtIndex:withGlyph:</a></h3>
- (void) <b>replaceGlyphAtIndex:</b> (unsigned)index<b> withGlyph:</b> (NSGlyph)newGlyph;<br />
<p>
</p>
<hr />
<h3>replaceTextStorage:</a></h3>
- (void) <b>replaceTextStorage:</b> (<a href="NSTextStorage.html#class$NSTextStorage">NSTextStorage</a>*)newTextStorage;<br />
<p>
</p>
<hr />
<h3>setAttachmentSize:forGlyphRange:</a></h3>
- (void) <b>setAttachmentSize:</b> (NSSize)attachmentSize<b> forGlyphRange:</b> (NSRange)glyphRange;<br />
<p>
</p>
<hr />
<h3>setBackgroundLayoutEnabled:</a></h3>
- (void) <b>setBackgroundLayoutEnabled:</b> (BOOL)flag;<br />
<p>
</p>
<hr />
<h3>setCharacterIndex:forGlyphAtIndex:</a></h3>
- (void) <b>setCharacterIndex:</b> (unsigned)charIndex<b> forGlyphAtIndex:</b> (unsigned)glyphIndex;<br />
<p>
</p>
<hr />
<h3>setDelegate:</a></h3>
- (void) <b>setDelegate:</b> (id)aDelegate;<br />
<p>
</p>
<hr />
<h3>setDrawsOutsideLineFragment:forGlyphAtIndex:</a></h3>
- (void) <b>setDrawsOutsideLineFragment:</b> (BOOL)flag<b> forGlyphAtIndex:</b> (unsigned)glyphIndex;<br />
<p>
</p>
<hr />
<h3>setExtraLineFragmentRect:usedRect:textContainer:</a></h3>
- (void) <b>setExtraLineFragmentRect:</b> (NSRect)aRect<b> usedRect:</b> (NSRect)usedRect<b> textContainer:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)aTextContainer;<br />
<p>
</p>
<hr />
<h3>setIntAttribute:value:forGlyphAtIndex:</a></h3>
- (void) <b>setIntAttribute:</b> (int)attribute<b> value:</b> (int)anInt<b> forGlyphAtIndex:</b> (unsigned)glyphIndex;<br />
<p>
</p>
<hr />
<h3>setLineFragmentRect:forGlyphRange:usedRect:</a></h3>
- (void) <b>setLineFragmentRect:</b> (NSRect)fragmentRect<b> forGlyphRange:</b> (NSRange)glyphRange<b> usedRect:</b> (NSRect)usedRect;<br />
<p>
</p>
<hr />
<h3>setLocation:forStartOfGlyphRange:</a></h3>
- (void) <b>setLocation:</b> (NSPoint)aPoint<b> forStartOfGlyphRange:</b> (NSRange)glyphRange;<br />
<p>
</p>
<hr />
<h3>setNotShownAttribute:forGlyphAtIndex:</a></h3>
- (void) <b>setNotShownAttribute:</b> (BOOL)flag<b> forGlyphAtIndex:</b> (unsigned)glyphIndex;<br />
<p>
</p>
<hr />
<h3>setShowsControlCharacters:</a></h3>
- (void) <b>setShowsControlCharacters:</b> (BOOL)flag;<br />
<p>
</p>
<hr />
<h3>setShowsInvisibleCharacters:</a></h3>
- (void) <b>setShowsInvisibleCharacters:</b> (BOOL)flag;<br />
<p>
</p>
<hr />
<h3>setTextContainer:forGlyphRange:</a></h3>
- (void) <b>setTextContainer:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)aTextContainer<b> forGlyphRange:</b> (NSRange)glyphRange;<br />
<p>
</p>
<hr />
<h3>setTextStorage:</a></h3>
- (void) <b>setTextStorage:</b> (<a href="NSTextStorage.html#class$NSTextStorage">NSTextStorage</a>*)aTextStorage;<br />
<p>
</p>
<hr />
<h3>setUsesScreenFonts:</a></h3>
- (void) <b>setUsesScreenFonts:</b> (BOOL)flag;<br />
<p>
</p>
<hr />
<h3>showsControlCharacters</a></h3>
- (BOOL) <b>showsControlCharacters</b>;<br />
<p>
</p>
<hr />
<h3>showsInvisibleCharacters</a></h3>
- (BOOL) <b>showsInvisibleCharacters</b>;<br />
<p>
</p>
<hr />
<h3>substituteFontForFont:</a></h3>
- (<a href="NSFont.html#class$NSFont">NSFont</a>*) <b>substituteFontForFont:</b> (<a href="NSFont.html#class$NSFont">NSFont</a>*)originalFont;<br />
<p>
</p>
<hr />
<h3>textContainerChangedGeometry:</a></h3>
- (void) <b>textContainerChangedGeometry:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)aContainer;<br />
<p>
</p>
<hr />
<h3>textContainerChangedTextView:</a></h3>
- (void) <b>textContainerChangedTextView:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)aContainer;<br />
<p>
</p>
<hr />
<h3>textContainerForGlyphAtIndex:effectiveRange:</a></h3>
- (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*) <b>textContainerForGlyphAtIndex:</b> (unsigned)glyphIndex<b> effectiveRange:</b> (NSRange*)effectiveRange;<br />
<p>
</p>
<hr />
<h3>textContainers</a></h3>
- (NSArray*) <b>textContainers</b>;<br />
<p>
</p>
<hr />
<h3>textStorage</a></h3>
- (<a href="NSTextStorage.html#class$NSTextStorage">NSTextStorage</a>*) <b>textStorage</b>;<br />
<p>
</p>
<hr />
<h3>textStorage:edited:range:changeInLength:invalidatedRange:</a></h3>
- (void) <b>textStorage:</b> (<a href="NSTextStorage.html#class$NSTextStorage">NSTextStorage</a>*)aTextStorage<b> edited:</b> (unsigned)mask<b> range:</b> (NSRange)range<b> changeInLength:</b> (int)lengthChange<b> invalidatedRange:</b> (NSRange)invalidatedRange;<br />
<p>
</p>
<hr />
<h3>usedRectForTextContainer:</a></h3>
- (NSRect) <b>usedRectForTextContainer:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)container;<br />
<p>
</p>
<hr />
<h3>usesScreenFonts</a></h3>
- (BOOL) <b>usesScreenFonts</b>;<br />
<p>
</p>
<hr />
<h1>
Software documentation for the
NSLayoutManager(NSTextViewSupport)
category
</h1>
<h2><a href="#class$NSLayoutManager">NSLayoutManager</a>(<a name="category$NSLayoutManager(NSTextViewSupport)">NSTextViewSupport</a>)</h2>
Declared: AppKit/NSLayoutManager.h<br />
<p>
</p>
<h3>_charIndexForInsertionPointMovingFromY:bestX:up:textContainer:</a></h3>
- (unsigned) <b>_charIndexForInsertionPointMovingFromY:</b> (float)position<b> bestX:</b> (float)wanted<b> up:</b> (BOOL)upFlag<b> textContainer:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)tc;<br />
<p>
</p>
<hr />
<h3>drawBackgroundForGlyphRange:atPoint:</a></h3>
- (void) <b>drawBackgroundForGlyphRange:</b> (NSRange)glyphsToShow<b> atPoint:</b> (NSPoint)origin;<br />
<p>
</p>
<hr />
<h3>drawGlyphsForGlyphRange:atPoint:</a></h3>
- (void) <b>drawGlyphsForGlyphRange:</b> (NSRange)glyphsToShow<b> atPoint:</b> (NSPoint)origin;<br />
<p>
</p>
<hr />
<h3>drawUnderlineForGlyphRange:underlineType:baselineOffset:lineFragmentRect:lineFragmentGlyphRange:containerOrigin:</a></h3>
- (void) <b>drawUnderlineForGlyphRange:</b> (NSRange)glyphRange<b> underlineType:</b> (int)underlineVal<b> baselineOffset:</b> (float)baselineOffset<b> lineFragmentRect:</b> (NSRect)lineRect<b> lineFragmentGlyphRange:</b> (NSRange)lineGlyphRange<b> containerOrigin:</b> (NSPoint)containerOrigin;<br />
<p>
</p>
<hr />
<h3>firstTextView</a></h3>
- (<a href="NSTextView.html#class$NSTextView">NSTextView</a>*) <b>firstTextView</b>;<br />
<p>
</p>
<hr />
<h3>hyphenationFactor</a></h3>
- (float) <b>hyphenationFactor</b>;<br />
<p>
</p>
<hr />
<h3>layoutManagerOwnsFirstResponderInWindow:</a></h3>
- (BOOL) <b>layoutManagerOwnsFirstResponderInWindow:</b> (<a href="NSWindow.html#class$NSWindow">NSWindow</a>*)window;<br />
<p>
</p>
<hr />
<h3>rulerAccessoryViewForTextView:paragraphStyle:ruler:enabled:</a></h3>
- (<a href="NSView.html#class$NSView">NSView</a>*) <b>rulerAccessoryViewForTextView:</b> (<a href="NSTextView.html#class$NSTextView">NSTextView</a>*)view<b> paragraphStyle:</b> (<a href="NSParagraphStyle.html#class$NSParagraphStyle">NSParagraphStyle</a>*)style<b> ruler:</b> (<a href="NSRulerView.html#class$NSRulerView">NSRulerView</a>*)ruler<b> enabled:</b> (BOOL)isEnabled;<br />
<p>
</p>
<hr />
<h3>rulerMarkersForTextView:paragraphStyle:ruler:</a></h3>
- (NSArray*) <b>rulerMarkersForTextView:</b> (<a href="NSTextView.html#class$NSTextView">NSTextView</a>*)view<b> paragraphStyle:</b> (<a href="NSParagraphStyle.html#class$NSParagraphStyle">NSParagraphStyle</a>*)style<b> ruler:</b> (<a href="NSRulerView.html#class$NSRulerView">NSRulerView</a>*)ruler;<br />
<p>
</p>
<hr />
<h3>setHyphenationFactor:</a></h3>
- (void) <b>setHyphenationFactor:</b> (float)factor;<br />
<p>
</p>
<hr />
<h3>textViewForBeginningOfSelection</a></h3>
- (<a href="NSTextView.html#class$NSTextView">NSTextView</a>*) <b>textViewForBeginningOfSelection</b>;<br />
<p>
</p>
<hr />
<h3>underlineGlyphRange:underlineType:lineFragmentRect:lineFragmentGlyphRange:containerOrigin:</a></h3>
- (void) <b>underlineGlyphRange:</b> (NSRange)glyphRange<b> underlineType:</b> (int)underlineVal<b> lineFragmentRect:</b> (NSRect)lineRect<b> lineFragmentGlyphRange:</b> (NSRange)lineGlyphRange<b> containerOrigin:</b> (NSPoint)containerOrigin;<br />
<p>
</p>
<hr />
<h1>
Software documentation for the
NSObject(NSLayoutManagerDelegate)
category
</h1>
<h2>NSObject(<a name="category$NSObject(NSLayoutManagerDelegate)">NSLayoutManagerDelegate</a>)</h2>
Declared: AppKit/NSLayoutManager.h<br />
<p>
</p>
<h3>layoutManager:didCompleteLayoutForTextContainer:atEnd:</a></h3>
- (void) <b>layoutManager:</b> (<a href="#class$NSLayoutManager">NSLayoutManager</a>*)layoutManager<b> didCompleteLayoutForTextContainer:</b> (<a href="NSTextContainer.html#class$NSTextContainer">NSTextContainer</a>*)textContainer<b> atEnd:</b> (BOOL)layoutFinishedFlag;<br />
<p>
</p>
<hr />
<h3>layoutManagerDidInvalidateLayout:</a></h3>
- (void) <b>layoutManagerDidInvalidateLayout:</b> (<a href="#class$NSLayoutManager">NSLayoutManager</a>*)sender;<br />
<p>
</p>
<hr />
</body>
</html>