[Previous] [Class List] [Next]

NSTextAttachment


Inherits from: NSObject
Conforms to: NSObject
(NSObject)
Declared in: AppKit/NSTextAttachment.h




Class Description


NSTextAttachment objects are used by the NSAttributedString class cluster as the values for attachment attributes (stored in the attributed string under the key named NSAttachmentAttributeName). The objects you create with this class are referred to as text attachment objects, or when no confusion will result, as text attachments or merely attachments. See the NSAttributedString and NSTextView class specifications for general information on text attachments.

A text attachment object contains an NSFileWrapper, which in turn holds the contents of the attached file. It also uses a cell object conforming to the NSTextAttachmentCell protocol to draw and handle mouse events. Most of the behavior of a text attachment is relegated to the file wrapper and the attachment cell. See the corresponding class and protocol specifications for more information.


Method Types


Creating an NSTextAttachment
- initWithFileWrapper:
Setting the file wrapper
- setFileWrapper:
- fileWrapper
Setting the attachment cell
- setAttachmentCell:
- attachmentCell


Instance Methods



attachmentCell

- (id <NSTextAttachmentCell>)attachmentCell

Returns the object used to draw the icon for the attachment and to handle mouse events. An NSTextAttachment by default uses an NSTextAttachmentCell that displays the attached file's icon, or its contents if the file contains an image.

See Also: - fileWrapper, - image (NSCell) - icon (NSFileWrapper), - setAttachmentCell:



fileWrapper

- (NSFileWrapper *)fileWrapper

Returns the receiver's file wrapper, which holds the contents of the attached file.

See Also: - setFileWrapper:



initWithFileWrapper:

- (id)initWithFileWrapper:(NSFileWrapper *)aWrapper

Initializes a newly allocated NSTextAttachment to contain aWrapper and use an NSTextAttachmentCell as its attachment cell. If aWrapper contains an image file that the receiver can interpret as an NSImage object, sets the attachment cell's image to the NSImage rather than to aWrapper's icon.

This method is the designated initializer for the NSTextAttachment class. Returns self.

See Also: - setFileWrapper:, - setAttachmentCell:



setAttachmentCell:

- (void)setAttachmentCell:(id <NSTextAttachmentCell>)aCell

Sets the object used to draw the icon for the attachment and to handle mouse events to aCell.

See Also: - setFileWrapper:, - setImage: (NSCell) - icon (NSFileWrapper), - attachmentCell



setFileWrapper:

- (void)setFileWrapper:(NSFileWrapper *)aWrapper

Sets the receiver's file wrapper, which holds the contents of the attached file, to aWrapper.

See Also: - fileWrapper




[Previous] [Next]