NSAttributedString+Cocoa.h

Go to the documentation of this file.

//
//  NSAttributedString+Cocoa.h
//  FoundationExtension
//
//  Created by Jeong YunWon on 12. 10. 31..
//  Copyright (c) 2012 youknowone.org. All rights reserved.
//

#import <Cocoa/Cocoa.h>
#import <FoundationExtension/NSADictionary.h>

enum {
    NSLigatureNo = 0,
    NSLigatureStandard = 1, // default
    NSLigatureAll = 2,
};
typedef NSUInteger NSLigatureType;

#if __MAC_OS_X_VERSION_MAX_ALLOWED < 101100
typedef NSInteger NSUnderlineStyle;  // Only type is required

#define NSTextAlignmentLeft NSLeftTextAlignment
#define NSTextAlignmentRight NSRightTextAlignment
#define NSTextAlignmentCenter NSCenterTextAlignment
#define NSTextAlignmentJustified NSJustifiedTextAlignment
#define NSTextAlignmentNatural NSNaturalTextAlignment

typedef NSInteger NSWritingDirectionFormatType;
#define NSWritingDirectionEmbedding kCTWritingDirectionEmbedding
#define NSWritingDirectionOverride kCTWritingDirectionOverride

#endif

enum {
    NSWritingDirectionAttributeLRE = 1 << (NSWritingDirectionLeftToRight | NSWritingDirectionEmbedding),
    NSWritingDirectionAttributeRLE = 1 << (NSWritingDirectionRightToLeft | NSWritingDirectionEmbedding),
    NSWritingDirectionAttributeLRO = 1 << (NSWritingDirectionLeftToRight | NSWritingDirectionOverride),
    NSWritingDirectionAttributeRLO = 1 << (NSWritingDirectionRightToLeft | NSWritingDirectionOverride),
};
typedef NSUInteger NSWritingDirectionAttributes;

enum {
    NSVerticalGlyphFormHorizontal = 0,
    NSVerticalGlyphFormVertical = 1,
};
typedef NSUInteger NSVerticalGlyphForm;


@interface NSMutableAttributedString (AttributeProperties)

- (void)addAttributeWritingDirectionArray:(NSArray *)writingDirectionArray range:(NSRange)range NS_AVAILABLE_MAC(10_6);


- (void)addAttributeFont:(NSFont *)font range:(NSRange)range;
- (void)removeAttributeFontFromRange:(NSRange)range;

- (void)addAttributeParagraphStyle:(NSParagraphStyle *)paragraphStyle range:(NSRange)range;
- (void)removeAttributeParagraphStyleFromRange:(NSRange)range;

- (void)addAttributeForegroundColor:(NSColor *)foregroundColor range:(NSRange)range;
- (void)removeAttributeForegroundColorFromRange:(NSRange)range;

- (void)addAttributeUnderlineStyle:(NSUnderlineStyle)underlineStyle range:(NSRange)range;
- (void)removeAttributeUnderlineStyleFromRange:(NSRange)range;

- (void)addAttributeSuperscript:(BOOL)superscript range:(NSRange)range;
- (void)removeAttributeSuperscriptFromRange:(NSRange)range;

- (void)addAttributeBackgroundColor:(NSColor *)backgroundColor range:(NSRange)range;
- (void)removeAttributeBackgroundColorFromRange:(NSRange)range;

- (void)addAttributeAttachment:(NSTextAttachment *)attachment range:(NSRange)range;
- (void)removeAttributeAttachmentFromRange:(NSRange)range;

- (void)addAttributeLigature:(NSLigatureType)ligature range:(NSRange)range;
- (void)removeAttributeLigatureFromRange:(NSRange)range;

- (void)addAttributeBaselineOffset:(float)baselineOffset range:(NSRange)range;
- (void)removeAttributeBaselineOffsetFromRange:(NSRange)range;

- (void)addAttributeKern:(float)kern range:(NSRange)range;
- (void)removeAttributeKernFromRange:(NSRange)range;

- (void)addAttributeLink:(NSURL *)link range:(NSRange)range;
- (void)removeAttributeLinkFromRange:(NSRange)range;

- (void)addAttributeStrokeWidth:(float)strokeWidth range:(NSRange)range;
- (void)removeAttributeStrokeWidthFromRange:(NSRange)range;

- (void)addAttributeStrokeColor:(NSColor *)strokeColor range:(NSRange)range;
- (void)removeAttributeStrokeColorFromRange:(NSRange)range;

- (void)addAttributeUnderlineColor:(NSColor *)underlineColor range:(NSRange)range;
- (void)removeAttributeUnderlineColorFromRange:(NSRange)range;

- (void)addAttributeStrikethroughStyle:(NSUnderlineStyle)strikethroughStyle range:(NSRange)range;
- (void)removeAttributeStrikethroughStyleFromRange:(NSRange)range;

- (void)addAttributeStrikethroughColor:(NSColor *)strikethroughColor range:(NSRange)range;
- (void)removeAttributeStrikethroughColorFromRange:(NSRange)range;

- (void)addAttributeShadow:(NSShadow *)shadow range:(NSRange)range;
- (void)removeAttributeShadowFromRange:(NSRange)range;

- (void)addAttributeObliqueness:(float)obliqueness range:(NSRange)range;
- (void)removeAttributeObliquenessFromRange:(NSRange)range;

- (void)addAttributeExpansion:(float)expansion range:(NSRange)range;
- (void)removeAttributeExpansionFromRange:(NSRange)range;

- (void)addAttributeCursor:(NSCursor *)cursor range:(NSRange)range;
- (void)removeAttributeCursorFromRange:(NSRange)range;

- (void)addAttributeToolTip:(NSString *)toolTip range:(NSRange)range;
- (void)removeAttributeToolTipFromRange:(NSRange)range;

#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 1050

- (void)addAttributeMarkedClauseSegment:(NSInteger)markedClauseSegment range:(NSRange)range NS_AVAILABLE_MAC(10_5);
- (void)removeAttributeMarkedClauseSegmentFromRange:(NSRange)range NS_AVAILABLE_MAC(10_5);
#endif
#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 1060

- (void)addAttributeWritingDirection:(NSWritingDirectionAttributes)writingDirection range:(NSRange)range NS_AVAILABLE_MAC(10_6);
- (void)removeAttributeWritingDirectionFromRange:(NSRange)range NS_AVAILABLE_MAC(10_6);
#endif
#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 1070

- (void)addAttributeVerticalGlyphForm:(NSVerticalGlyphForm)verticalGlyphForm range:(NSRange)range NS_AVAILABLE_MAC(10_7);
- (void)removeAttributeVerticalGlyphFormFromRange:(NSRange)range NS_AVAILABLE_MAC(10_7);
#endif
#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 1080

- (void)addAttributeTextAlternatives:(NSTextAlternatives *)textAlternatives range:(NSRange)range NS_AVAILABLE_MAC(10_8);
- (void)removeAttributeTextAlternativesFromRange:(NSRange)range NS_AVAILABLE_MAC(10_8);
#endif

@end


@interface NSAttributedStringAttributeDictionary: NSAMutableDictionary

@property(strong) NSFont *font;
@property(strong) NSParagraphStyle *paragraphStyle;
@property(strong) NSColor *foregroundColor;
@property(strong) NSNumber *underlineStyleNumber;
@property(assign) NSUnderlineStyle underlineStyle;
@property(strong) NSNumber *superscriptNumber;
@property(assign) BOOL superscript;
@property(strong) NSColor *backgroundColor;
@property(strong) NSTextAttachment *attachment;
@property(strong) NSNumber *ligatureNumber;
@property(assign) NSLigatureType ligature;
@property(strong) NSNumber *baselineOffsetNumber;
@property(assign) float baselineOffset;
@property(strong) NSNumber *kernNumber;
@property(assign) float kern;
@property(strong) NSURL *link;
@property(strong) NSNumber *strokeWidthNumber;
@property(assign) float strokeWidth;
@property(strong) NSColor *strokeColor;
@property(strong) NSColor *underlineColor;
@property(strong) NSNumber *strikethroughStyleNumber;
@property(assign) NSUnderlineStyle strikethroughStyle;
@property(strong) NSColor *strikethroughColor;
@property(strong) NSShadow *shadow;
@property(strong) NSNumber *obliquenessNumber;
@property(assign) float obliqueness;
@property(strong) NSNumber *expansionNumber;
@property(assign) float expansion;
@property(strong) NSCursor *cursor;
@property(strong) NSString *toolTip;
#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 1050

@property(strong) NSNumber *markedClauseSegmentNumber NS_AVAILABLE_MAC(10_5);
#endif

#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 1050

@property(assign) NSInteger markedClauseSegment NS_AVAILABLE_MAC(10_5);
#endif
#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 1060

@property(strong) NSArray *writingDirectionArray NS_AVAILABLE_MAC(10_6);
#endif
#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 1060

@property(assign) NSWritingDirectionAttributes writingDirection NS_AVAILABLE_MAC(10_6);
#endif
#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 1070

@property(strong) NSNumber *verticalGlyphFormNumber NS_AVAILABLE_MAC(10_7);
#endif

#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 1070

@property(assign) NSVerticalGlyphForm verticalGlyphForm NS_AVAILABLE_MAC(10_7);
#endif
#if __MAC_OS_X_VERSION_MAX_ALLOWED >= 1080

@property(strong) NSTextAlternatives *textAlternatives NS_AVAILABLE_MAC(10_8);
#endif
@end