Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

114 lines (80 sloc) 2.852 kb
//
// NSAttributedString+DTCoreText.h
// DTCoreText
//
// Created by Oliver Drobnik on 2/1/12.
// Copyright (c) 2012 Drobnik.com. All rights reserved.
//
@class DTCSSListStyle;
@class DTTextBlock;
/**
Convenience Methods that mimick similar methods available on Mac
*/
@interface NSAttributedString (DTCoreText)
/**
@name Working with Text Attachments
*/
/**
Retrieves the DTTextAttachment objects that match the given predicate.
With this method you can for example find all images that have a certain URL.
@param predicate The predicate to apply for filtering or `nil` for all attachments.
@returns The filtered array of attachments
*/
- (NSArray *)textAttachmentsWithPredicate:(NSPredicate *)predicate;
/**
@name Calculating Ranges
*/
/**
Returns the index of the item at the given location within the list.
@param list The text list.
@param location The location of the item.
@returns Returns the index within the list.
*/
- (NSInteger)itemNumberInTextList:(DTCSSListStyle *)list atIndex:(NSUInteger)location;
/**
Returns the range of the given text list that contains the given location.
@param list The text list.
@param location The location in the text.
@returns The range of the given text list containing the location.
*/
- (NSRange)rangeOfTextList:(DTCSSListStyle *)list atIndex:(NSUInteger)location;
/**
Returns the range of the given text block that contains the given location.
@param textBlock The text block.
@param location The location in the text.
@returns The range of the given text block containing the location.
*/
- (NSRange)rangeOfTextBlock:(DTTextBlock *)textBlock atIndex:(NSUInteger)location;
/**
Returns the range of the given href anchor.
@param anchorName The name of the anchor.
@returns The range of the given anchor.
*/
- (NSRange)rangeOfAnchorNamed:(NSString *)anchorName;
/**
@name Converting to Other Representations
*/
/**
Encodes the receiver into a generic HTML prepresentation.
@returns An HTML string.
*/
- (NSString *)htmlString;
/**
Converts the receiver into plain text.
This is different from the `string` method of `NSAttributedString` by also erasing placeholders for text attachments.
@returns The receiver converted to plain text.
*/
- (NSString *)plainTextString;
/**
@name Creating Special Attributed Strings
*/
/**
Create a prefix for a paragraph in a list
@param listCounter The value for the list item.
@param listStyle The list style
@param listIndent The amount in px to indent the list
@param attributes The attribute dictionary for the text to be prefixed
@returns An attributed string with the list prefix
*/
+ (NSAttributedString *)prefixForListItemWithCounter:(NSUInteger)listCounter listStyle:(DTCSSListStyle *)listStyle listIndent:(CGFloat)listIndent attributes:(NSDictionary *)attributes;
@end
Jump to Line
Something went wrong with that request. Please try again.