mirror of
https://github.com/gnustep/libs-gui.git
synced 2025-04-25 18:21:08 +00:00
7e691f69c9
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@32534 72102866-910b-0410-8b05-ffd578937521
309 lines
12 KiB
Objective-C
309 lines
12 KiB
Objective-C
/* -*-objc-*-
|
|
NSAttributedString.h
|
|
|
|
Categories which add capabilities to NSAttributedString
|
|
|
|
Copyright (C) 1999 Free Software Foundation, Inc.
|
|
|
|
Author: Richard Frith-Macdonald <richard@brainstorm.co.uk>
|
|
Date: July 1999
|
|
|
|
This file is part of the GNUstep GUI Library.
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; see the file COPYING.LIB.
|
|
If not, see <http://www.gnu.org/licenses/> or write to the
|
|
Free Software Foundation, 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef _GNUstep_H_NSAttributedString
|
|
#define _GNUstep_H_NSAttributedString
|
|
#import <GNUstepBase/GSVersionMacros.h>
|
|
|
|
#if OS_API_VERSION(GS_API_MACOSX, GS_API_LATEST)
|
|
|
|
#import <Foundation/NSAttributedString.h>
|
|
#import <Foundation/NSRange.h>
|
|
#import <AppKit/NSFontManager.h>
|
|
// for NSWritingDirection
|
|
#import <AppKit/NSParagraphStyle.h>
|
|
#import <AppKit/NSText.h>
|
|
#import <AppKit/AppKitDefines.h>
|
|
|
|
@class NSTextAttachment;
|
|
@class NSFileWrapper;
|
|
@class NSString;
|
|
@class NSDictionary;
|
|
@class NSData;
|
|
@class NSArray;
|
|
@class NSURL;
|
|
@class NSError;
|
|
@class NSTextBlock;
|
|
@class NSTextList;
|
|
@class NSTextTable;
|
|
|
|
/* Global NSString attribute names used in accessing the respective
|
|
property in a text attributes dictionary. if the key is not in the
|
|
dictionary the default value is assumed. */
|
|
APPKIT_EXPORT NSString *NSAttachmentAttributeName;
|
|
APPKIT_EXPORT NSString *NSBackgroundColorAttributeName;
|
|
APPKIT_EXPORT NSString *NSBaselineOffsetAttributeName;
|
|
APPKIT_EXPORT NSString *NSCursorAttributeName;
|
|
APPKIT_EXPORT NSString *NSExpansionAttributeName;
|
|
APPKIT_EXPORT NSString *NSFontAttributeName;
|
|
APPKIT_EXPORT NSString *NSForegroundColorAttributeName;
|
|
APPKIT_EXPORT NSString *NSKernAttributeName;
|
|
APPKIT_EXPORT NSString *NSLigatureAttributeName;
|
|
APPKIT_EXPORT NSString *NSLinkAttributeName;
|
|
APPKIT_EXPORT NSString *NSObliquenessAttributeName;
|
|
APPKIT_EXPORT NSString *NSParagraphStyleAttributeName;
|
|
APPKIT_EXPORT NSString *NSShadowAttributeName;
|
|
APPKIT_EXPORT NSString *NSStrikethroughColorAttributeName;
|
|
APPKIT_EXPORT NSString *NSStrikethroughStyleAttributeName;
|
|
APPKIT_EXPORT NSString *NSStrokeColorAttributeName;
|
|
APPKIT_EXPORT NSString *NSStrokeWidthAttributeName;
|
|
APPKIT_EXPORT NSString *NSSuperscriptAttributeName;
|
|
APPKIT_EXPORT NSString *NSToolTipAttributeName;
|
|
APPKIT_EXPORT NSString *NSUnderlineColorAttributeName;
|
|
APPKIT_EXPORT NSString *NSUnderlineStyleAttributeName;
|
|
|
|
#if OS_API_VERSION(MAC_OS_X_VERSION_10_2, GS_API_LATEST)
|
|
APPKIT_EXPORT NSString *NSGlyphInfoAttributeName;
|
|
#endif
|
|
|
|
#if OS_API_VERSION(MAC_OS_X_VERSION_10_4, GS_API_LATEST)
|
|
APPKIT_EXPORT NSString *NSPaperSizeDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSLeftMarginDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSRightMarginDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSTopMarginDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSBottomMarginDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSHyphenationFactorDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSDocumentTypeDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSCharacterEncodingDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSViewSizeDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSViewZoomDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSViewModeDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSBackgroundColorDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSCocoaVersionDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSReadOnlyDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSConvertedDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSDefaultTabIntervalDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSTitleDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSCompanyDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSCopyrightDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSSubjectDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSAuthorDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSKeywordsDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSCommentDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSEditorDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSCreationTimeDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSModificationTimeDocumentAttribute;
|
|
|
|
// DocumentType values
|
|
|
|
APPKIT_EXPORT NSString *NSPlainTextDocumentType;
|
|
APPKIT_EXPORT NSString *NSRTFTextDocumentType;
|
|
APPKIT_EXPORT NSString *NSRTFDTextDocumentType;
|
|
APPKIT_EXPORT NSString *NSMacSimpleTextDocumentType;
|
|
APPKIT_EXPORT NSString *NSHTMLTextDocumentType;
|
|
APPKIT_EXPORT NSString *NSDocFormatTextDocumentType;
|
|
APPKIT_EXPORT NSString *NSWordMLTextDocumentType;
|
|
|
|
// for HTML export
|
|
|
|
APPKIT_EXPORT NSString *NSExcludedElementsDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSTextEncodingNameDocumentAttribute;
|
|
APPKIT_EXPORT NSString *NSPrefixSpacesDocumentAttribute;
|
|
|
|
// for HTML import
|
|
|
|
APPKIT_EXPORT NSString *NSBaseURLDocumentOption;
|
|
APPKIT_EXPORT NSString *NSCharacterEncodingDocumentOption;
|
|
APPKIT_EXPORT NSString *NSDefaultAttributesDocumentOption;
|
|
APPKIT_EXPORT NSString *NSDocumentTypeDocumentOption;
|
|
APPKIT_EXPORT NSString *NSTextEncodingNameDocumentOption;
|
|
APPKIT_EXPORT NSString *NSTextSizeMultiplierDocumentOption;
|
|
APPKIT_EXPORT NSString *NSTimeoutDocumentOption;
|
|
APPKIT_EXPORT NSString *NSWebPreferencesDocumentOption;
|
|
APPKIT_EXPORT NSString *NSWebResourceLoadDelegateDocumentOption;
|
|
|
|
// special attributes
|
|
|
|
APPKIT_EXPORT NSString *NSCharacterShapeAttributeName;
|
|
APPKIT_EXPORT const unsigned NSUnderlineByWordMask;
|
|
APPKIT_EXPORT NSString *NSSpellingStateAttributeName;
|
|
APPKIT_EXPORT const unsigned NSSpellingStateSpellingFlag;
|
|
APPKIT_EXPORT const unsigned NSSpellingStateGrammarFlag;
|
|
|
|
// readFrom... attributes
|
|
|
|
APPKIT_EXPORT NSString *NSCharacterEncodingDocumentOption;
|
|
APPKIT_EXPORT NSString *NSBaseURLDocumentOption;
|
|
APPKIT_EXPORT NSString *NSDefaultAttributesDocumentOption;
|
|
APPKIT_EXPORT NSString *NSDocumentTypeDocumentOption;
|
|
|
|
// initWithHTML... attributes
|
|
|
|
APPKIT_EXPORT NSString *NSTextEncodingNameDocumentOption;
|
|
APPKIT_EXPORT NSString *NSTimeoutDocumentOption;
|
|
APPKIT_EXPORT NSString *NSWebPreferencesDocumentOption;
|
|
APPKIT_EXPORT NSString *NSWebResourceLoadDelegateDocumentOption;
|
|
APPKIT_EXPORT NSString *NSTextSizeMultiplierDocumentOption;
|
|
|
|
/* Currently supported values for NSUnderlineStyleAttributeName. */
|
|
enum _NSUnderlineStyle
|
|
{
|
|
NSUnderlineStyleNone = 0x00,
|
|
NSUnderlineStyleSingle = 0x01,
|
|
NSUnderlineStyleThick = 0x02,
|
|
NSUnderlineStyleDouble = 0x09
|
|
};
|
|
|
|
enum _NSUnderlinePattern
|
|
{
|
|
NSUnderlinePatternSolid = 0x0000,
|
|
NSUnderlinePatternDot = 0x0100,
|
|
NSUnderlinePatternDash = 0x0200,
|
|
NSUnderlinePatternDashDot = 0x0300,
|
|
NSUnderlinePatternDashDotDot = 0x0400
|
|
};
|
|
#endif
|
|
|
|
#if OS_API_VERSION(GS_API_MACOSX, MAC_OS_X_VERSION_10_3)
|
|
// Deprecated
|
|
enum
|
|
{
|
|
GSNoUnderlineStyle = 0,
|
|
NSSingleUnderlineStyle = 1,
|
|
NSUnderlineStrikethroughMask
|
|
};
|
|
#endif
|
|
|
|
@interface NSAttributedString (AppKit)
|
|
- (BOOL) containsAttachments;
|
|
- (NSDictionary*) fontAttributesInRange: (NSRange)range;
|
|
- (NSDictionary*) rulerAttributesInRange: (NSRange)range;
|
|
- (NSUInteger) lineBreakBeforeIndex: (NSUInteger)location
|
|
withinRange: (NSRange)aRange;
|
|
- (NSRange) doubleClickAtIndex: (NSUInteger)location;
|
|
- (NSUInteger) nextWordFromIndex: (NSUInteger)location forward: (BOOL)isForward;
|
|
|
|
- (id) initWithRTF: (NSData*)data documentAttributes: (NSDictionary**)dict;
|
|
- (id) initWithRTFD: (NSData*)data documentAttributes: (NSDictionary**)dict;
|
|
- (id) initWithPath: (NSString*)path documentAttributes: (NSDictionary**)dict;
|
|
- (id) initWithURL: (NSURL*)url documentAttributes: (NSDictionary**)dict;
|
|
- (id) initWithRTFDFileWrapper: (NSFileWrapper*)wrapper
|
|
documentAttributes: (NSDictionary**)dict;
|
|
- (id) initWithHTML: (NSData*)data documentAttributes: (NSDictionary**)dict;
|
|
- (id) initWithHTML: (NSData*)data
|
|
baseURL: (NSURL*)base
|
|
documentAttributes: (NSDictionary**)dict;
|
|
|
|
- (NSData*) RTFFromRange: (NSRange)range
|
|
documentAttributes: (NSDictionary*)dict;
|
|
- (NSData*) RTFDFromRange: (NSRange)range
|
|
documentAttributes: (NSDictionary*)dict;
|
|
- (NSFileWrapper*) RTFDFileWrapperFromRange: (NSRange)range
|
|
documentAttributes: (NSDictionary*)dict;
|
|
|
|
#if OS_API_VERSION(GS_API_MACOSX, GS_API_LATEST)
|
|
+ (NSArray *) textFileTypes;
|
|
+ (NSArray *) textPasteboardTypes;
|
|
+ (NSArray *) textUnfilteredFileTypes;
|
|
+ (NSArray *) textUnfilteredPasteboardTypes;
|
|
#endif
|
|
#if OS_API_VERSION(MAC_OS_X_VERSION_10_5, GS_API_LATEST)
|
|
+ (NSArray *) textTypes;
|
|
+ (NSArray *) textUnfilteredTypes;
|
|
#endif
|
|
#if OS_API_VERSION(MAC_OS_X_VERSION_10_3, GS_API_LATEST)
|
|
- (NSData *) docFormatFromRange: (NSRange)range
|
|
documentAttributes: (NSDictionary *)dict;
|
|
- (id) initWithDocFormat: (NSData *)data
|
|
documentAttributes: (NSDictionary **)dict;
|
|
- (id) initWithHTML: (NSData *)data
|
|
options: (NSDictionary *)options
|
|
documentAttributes: (NSDictionary **)dict;
|
|
|
|
- (NSUInteger) lineBreakByHyphenatingBeforeIndex: (NSUInteger)location
|
|
withinRange: (NSRange)aRange;
|
|
#endif
|
|
#if OS_API_VERSION(MAC_OS_X_VERSION_10_4, GS_API_LATEST)
|
|
- (NSData *) dataFromRange: (NSRange)range
|
|
documentAttributes: (NSDictionary *)dict
|
|
error: (NSError **)error;
|
|
- (NSFileWrapper *) fileWrapperFromRange: (NSRange)range
|
|
documentAttributes: (NSDictionary *)dict
|
|
error: (NSError **)error;
|
|
- (id) initWithData: (NSData *)data
|
|
options: (NSDictionary *)options
|
|
documentAttributes: (NSDictionary **)dict
|
|
error: (NSError **)error;
|
|
- (id) initWithURL: (NSURL *)url
|
|
options: (NSDictionary *)options
|
|
documentAttributes: (NSDictionary **)dict
|
|
error: (NSError **)error;
|
|
|
|
- (NSInteger) itemNumberInTextList: (NSTextList *)list
|
|
atIndex: (NSUInteger)location;
|
|
- (NSRange) rangeOfTextBlock: (NSTextBlock *)block
|
|
atIndex: (NSUInteger)location;
|
|
- (NSRange) rangeOfTextList: (NSTextList *)list
|
|
atIndex: (NSUInteger)location;
|
|
- (NSRange) rangeOfTextTable: (NSTextTable *)table
|
|
atIndex: (NSUInteger)location;
|
|
#endif
|
|
@end
|
|
|
|
@interface NSMutableAttributedString (AppKit)
|
|
- (void) superscriptRange: (NSRange)range;
|
|
- (void) subscriptRange: (NSRange)range;
|
|
- (void) unscriptRange: (NSRange)range;
|
|
- (void) applyFontTraits: (NSFontTraitMask)traitMask range: (NSRange)range;
|
|
- (void) setAlignment: (NSTextAlignment)alignment range: (NSRange)range;
|
|
|
|
- (void) fixAttributesInRange: (NSRange)range;
|
|
- (void) fixFontAttributeInRange: (NSRange)range;
|
|
- (void) fixParagraphStyleAttributeInRange: (NSRange)range;
|
|
- (void) fixAttachmentAttributeInRange: (NSRange)range;
|
|
|
|
- (void) updateAttachmentsFromPath: (NSString *)path;
|
|
|
|
- (BOOL) readFromURL: (NSURL *)url
|
|
options: (NSDictionary *)options
|
|
documentAttributes: (NSDictionary**)documentAttributes;
|
|
#if OS_API_VERSION(MAC_OS_X_VERSION_10_3, GS_API_LATEST)
|
|
- (BOOL) readFromData: (NSData *)data
|
|
options: (NSDictionary *)options
|
|
documentAttributes: (NSDictionary **)documentAttributes;
|
|
#endif
|
|
#if OS_API_VERSION(MAC_OS_X_VERSION_10_4, GS_API_LATEST)
|
|
- (BOOL) readFromData: (NSData *)data
|
|
options: (NSDictionary *)options
|
|
documentAttributes: (NSDictionary **)documentAttributes
|
|
error: (NSError **)error;
|
|
- (BOOL) readFromURL: (NSURL *)url
|
|
options: (NSDictionary *)options
|
|
documentAttributes: (NSDictionary **)documentAttributes
|
|
error: (NSError **)error;
|
|
|
|
- (void) setBaseWritingDirection: (NSWritingDirection)writingDirection
|
|
range: (NSRange)range;
|
|
#endif
|
|
@end
|
|
|
|
#endif
|
|
|
|
#endif
|
|
|