Inherits from | |
Conforms to | |
Framework | /System/Library/Frameworks/AppKit.framework |
Availability | Available in Mac OS X v10.0 and later. |
Companion guide | |
Declared in | NSParagraphStyle.h |
Related sample code |
NSParagraphStyle
and its subclass NSMutableParagraphStyle
encapsulate the paragraph or ruler attributes used by the NSAttributedString
classes. Instances of these classes are often referred to as paragraph style objects or, when no confusion will result, paragraph styles.
The mutable subclass of NSParagraphStyle
is NSMutableParagraphStyle.
– alignment
– firstLineHeadIndent
– headIndent
– tailIndent
– tabStops
– defaultTabInterval
– lineHeightMultiple
– maximumLineHeight
– minimumLineHeight
– lineSpacing
– paragraphSpacing
– paragraphSpacingBefore
Returns the default paragraph style.
+ (NSParagraphStyle *)defaultParagraphStyle
The default paragraph style has the following default values:
Subattribute |
Default Value |
---|---|
Alignment |
|
Tab stops |
12 left-aligned tabs, spaced by 28.0 points |
Line break mode |
|
All others |
0.0 |
See individual method descriptions for explanations of each subattribute.
NSParagraphStyle.h
Returns the default writing direction for the specified language.
+ (NSWritingDirection)defaultWritingDirectionForLanguage:(NSString *)languageName
The language specified in ISO language region format. Can be nil
to return a default writing direction derived from the user’s defaults database.
The default writing direction.
– baseWritingDirection
– setBaseWritingDirection:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the text alignment of the receiver.
- (NSTextAlignment)alignment
The text alignment.
Natural text alignment is realized as left or right alignment depending on the line sweep direction of the first script contained in the paragraph.
– setAlignment:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the base writing direction for the receiver.
- (NSWritingDirection)baseWritingDirection
The base writing direction for the receiver.
+ defaultWritingDirectionForLanguage:
– setBaseWritingDirection:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the document-wide default tab interval.
- (CGFloat)defaultTabInterval
The default tab interval in points. Tabs after the last specified in tabStops
are placed at integer multiples of this distance (if positive). Default return value is 0.0.
– setDefaultTabInterval:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the indentation of the first line of the receiver.
- (CGFloat)firstLineHeadIndent
The distance in points from the leading margin of a text container to the beginning of the paragraph’s first line. This value is always nonnegative.
– headIndent
– tailIndent
– setFirstLineHeadIndent:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Specifies whether the paragraph is to be treated as a header for purposes of HTML generation.
- (NSInteger)headerLevel
Returns 0 (the default value), if the paragraph is not a header, or from 1 through 6 if the paragraph is to be treated as a header.
– setHeaderLevel:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the indentation of the receiver’s lines other than the first.
- (CGFloat)headIndent
The distance in points from the leading margin of a text container to the beginning of lines other than the first. This value is always nonnegative.
– firstLineHeadIndent
– tailIndent
– setHeadIndent:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the paragraph’s threshold for hyphenation.
- (float)hyphenationFactor
A value between 0.0 and 1.0 inclusive. The default value is 0.0.
Hyphenation is attempted when the ratio of the text width (as broken without hyphenation) to the width of the line fragment is less than the hyphenation factor. When the paragraph’s hyphenation factor is 0.0, the layout manager’s hyphenation factor is used instead. When both are 0.0, hyphenation is disabled.
– setHyphenationFactor:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the mode that should be used to break lines in the receiver.
- (NSLineBreakMode)lineBreakMode
The line break mode to be used laying out the paragraph’s text.
– setLineBreakMode:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the line height multiple.
- (CGFloat)lineHeightMultiple
The line height multiple. The natural line height of the receiver is multiplied by this factor (if positive) before being constrained by minimum and maximum line height. Default return value is 0.0.
– maximumLineHeight
– minimumLineHeight
– setLineHeightMultiple:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the space between lines in the receiver (commonly known as leading).
- (CGFloat)lineSpacing
The space in points added between lines within the paragraph. This value is always nonnegative.
– maximumLineHeight
– minimumLineHeight
– paragraphSpacing
– setLineSpacing:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the receiver’s maximum line height.
- (CGFloat)maximumLineHeight
The maximum height in points that any line in the receiver will occupy, regardless of the font size or size of any attached graphic. This value is always nonnegative. The default value is 0.
Glyphs and graphics exceeding this height will overlap neighboring lines; however, a maximum height of 0 implies no line height limit. Although this limit applies to the line itself, line spacing adds extra space between adjacent lines.
– minimumLineHeight
– lineSpacing
– lineHeightMultiple
– setMaximumLineHeight:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the receiver’s minimum height.
- (CGFloat)minimumLineHeight
The minimum height in points that any line in the receiver will occupy, regardless of the font size or size of any attached graphic. This value is always nonnegative.
– maximumLineHeight
– lineSpacing
– lineHeightMultiple
– setMinimumLineHeight:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the space after the end of the paragraph.
- (CGFloat)paragraphSpacing
The space in points added at the end of the paragraph to separate it from the following paragraph. This value is always nonnegative.
This value is determined by adding the previous paragraph’s paragraphSpacing
and the current paragraph’s paragraphSpacingBefore
.
– lineSpacing
– paragraphSpacingBefore
– setParagraphSpacing:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the distance between the paragraph’s top and the beginning of its text content.
- (CGFloat)paragraphSpacingBefore
The distance in points between the paragraph’s top and the beginning of its text content. Default return value is 0.0.
– paragraphSpacing
– setParagraphSpacingBefore:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the receiver’s tab stops.
- (NSArray *)tabStops
The NSTextTab
objects, sorted by location, that define the tab stops for the paragraph style.
– location
(NSTextTab
)– setTabStops:
(NSMutableParagraphStyle
)– addTabStop:
(NSMutableParagraphStyle
)– removeTabStop:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the trailing indentation of the receiver.
- (CGFloat)tailIndent
The distance in points from the margin of a text container to the end of lines.
If positive, this value is the distance from the leading margin (for example, the left margin in left-to-right text). If 0 or negative, it’s the distance from the trailing margin.
For example, a paragraph style designed to fit exactly in a 2-inch wide container has a head indent of 0.0 and a tail indent of 0.0. One designed to fit with a quarter-inch margin has a head indent of 0.25 and a tail indent of –0.25.
– headIndent
– firstLineHeadIndent
– setTailIndent:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns an array specifying the text blocks containing the paragraph.
- (NSArray *)textBlocks
An array of the NSTextTableBlock
objects containing the paragraph, nested from outermost to innermost.
– setTextBlocks:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns an array specifying the text lists containing the paragraph.
- (NSArray *)textLists
An array of the NSTextList
objects containing the paragraph, nested from outermost to innermost.
– setTextLists:
(NSMutableParagraphStyle
)NSParagraphStyle.h
Returns the threshold for using tightening as an alternative to truncation.
- (float)tighteningFactorForTruncation
The tightening threshold value. The default value is 0.05.
When the line break mode specifies truncation, the text system attempts to tighten intercharacter spacing as an alternative to truncation, provided that the ratio of the text width to the line fragment width does not exceed 1.0 + the tightening factor returned by this method. Otherwise the text is truncated at a location determined by the line break mode.
– setTighteningFactorForTruncation:
(NSMutableParagraphStyle
)NSParagraphStyle.h
These constants specify what happens when a line is too long for its container.
typedef enum _NSLineBreakMode { NSLineBreakByWordWrapping = 0, NSLineBreakByCharWrapping, NSLineBreakByClipping, NSLineBreakByTruncatingHead, NSLineBreakByTruncatingTail, NSLineBreakByTruncatingMiddle } NSLineBreakMode;
NSLineBreakByWordWrapping
Wrapping occurs at word boundaries, unless the word itself doesn’t fit on a single line.
Available in Mac OS X v10.0 and later.
Declared in NSParagraphStyle.h
.
NSLineBreakByCharWrapping
Wrapping occurs before the first character that doesn’t fit.
Available in Mac OS X v10.0 and later.
Declared in NSParagraphStyle.h
.
NSLineBreakByClipping
Lines are simply not drawn past the edge of the text container.
Available in Mac OS X v10.0 and later.
Declared in NSParagraphStyle.h
.
NSLineBreakByTruncatingHead
Each line is displayed so that the end fits in the container and the missing text is indicated by some kind of ellipsis glyph.
Available in Mac OS X v10.0 and later.
Declared in NSParagraphStyle.h
.
NSLineBreakByTruncatingTail
Each line is displayed so that the beginning fits in the container and the missing text is indicated by some kind of ellipsis glyph.
Available in Mac OS X v10.0 and later.
Declared in NSParagraphStyle.h
.
NSLineBreakByTruncatingMiddle
Each line is displayed so that the beginning and end fit in the container and the missing text is indicated by some kind of ellipsis glyph in the middle.
Available in Mac OS X v10.0 and later.
Declared in NSParagraphStyle.h
.
NSParagraphStyle.h
These constants specify the types of tab stops.
typedef enum _NSTextTabType { NSLeftTabStopType = 0, NSRightTabStopType, NSCenterTabStopType, NSDecimalTabStopType } NSTextTabType;
NSLeftTabStopType
A left-aligned tab stop.
Available in Mac OS X v10.0 and later.
Declared in NSParagraphStyle.h
.
NSRightTabStopType
A right-aligned tab stop.
Available in Mac OS X v10.0 and later.
Declared in NSParagraphStyle.h
.
NSCenterTabStopType
A center-aligned tab stop.
Available in Mac OS X v10.0 and later.
Declared in NSParagraphStyle.h
.
NSDecimalTabStopType
Aligns columns of numbers by the decimal point.
Available in Mac OS X v10.0 and later.
Declared in NSParagraphStyle.h
.
NSParagraphStyle.h
© 2006 Apple Computer, Inc. All Rights Reserved. (Last updated: 2006-05-23)