This is NSCell.rtf in view mode; [Download] [Up]
paperh18648 margl-907 margr0 margt0 margb0 fi0 ri0 ql sb0 f1 fs24 Copyright f3 'e3f1 1994 by NeXT Computer, Inc. All Rights Reserved.
s4 li100 fi0 ri1007 ql f0 b fs36 fs100
fs36 NSCell
pard s14 li2872 fi-2771 ri1007 ql tx2872 f1 b0 fs28 fs48
fs28 f0 b fs24 Inherits From:tab b0 fs28 f1 NSObject
fs20
fs28 s7 f0 b fs24 Conforms To:tab b0 fs28 f1 NSCoding, NSCopying
fi0 NSObject (NSObject)
fs20
fs28 s8 fi-2771 f0 b fs24 Declared In:tab b0 fs28 f1 AppKit/NSCell.h
fs20
fs28 pard s19 li100 fi0 ri1007 ql f0 b fs28 fs20
fs28 Class Description
fs14
fs28 pard s1 li477 fi0 ri1007 ql tx2494 tx2872 tx3250 f1 b0 fs2
fs28 The NSCell class provides a mechanism for displaying text or images in an NSView without the overhead of a full NSView subclass. In particular, it provides much of the functionality of the NSText class by providing access to a shared NSText object used by all instances of NSCell in an application. NSCells are also extremely useful for placing titles or images at various locations in a custom subclass of NSView.
fs16
fs28 NSCell is used heavily by most of the NSControl classes to implement their internal workings. For example, NSSlider uses an NSSliderCell, NSTextField uses an NSTextFieldCell, and NSBrowser uses an NSBrowserCell. Sending a message to the NSControl is often simpler than dealing directly with the corresponding NSCell. For instance, NSControls typically invoke b updateCell:b0 (causing the cell to be displayed) after changing a cell attribute; whereas if you directly call the corresponding method of the NSCell, the NSCell might not automatically display itself again.
fs16
fs28 Some subclasses of NSControl (notably NSMatrix) allow multiple NSCells to be grouped and to act together in some cooperative manner. Thus, with an NSMatrix, a group of radio buttons can be implemented without needing an NSView for each button (and without needing an NSText object for the text on each button).
fs16
fs28 The NSCell class provides primitives for displaying text or an image, editing text, formatting floating-point numbers, maintaining state, highlighting, and tracking the mouse. NSCell'27s method b trackMouse:inRect:ofView:untilMouseUp:b0 supports the target object and action method used to implement controls. However, NSCell implements target/action features abstractly, deferring the details of implementation to subclasses of NSActionCell.
fs16
fs28 The b initImageCell:b0 method is the designated initializer for NSCells that display images. The b initTextCell:b0 method is the designated initializer for NSCells that display text. Override one or both of these methods if you implement a subclass of NSCell that performs its own initialization. If you need to use target and action behavior, you may prefer to subclass NSActionCell, which provides the default implementation of this behavior.
fs16
fs28 For more information on how NSCell is used, see the NSControl class specification.
fs16
fs28 pard s19 li100 fi0 ri1007 ql f0 b fs24
fs28 Initializing an NSCell
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (id)b initImageCell:b0 (NSImage *i )anImagei0 tab Initializes a new NSCell with the NSImage i anImage.
fi-6552 i0 fs16
fs28 fi-6552 {f3 -} (id)b initTextCell:b0 (NSString *)i aStringi0 tab Initializes a new NSCell with title i aStringi0 .
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Determining Component Sizes
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (void)b calcDrawInfo:b0 (NSRect)i aRecti0 tab Implemented by subclasses to recalculate drawing sizes.
fi-6552 fs16
fs28 fi-6552 {f3 -} (NSSize)b cellSizeb0 tab Returns the minimum size needed to display the NSCell.
fi-6552 fs16
fs28 fi-6552 {f3 -} (NSSize)b cellSizeForBounds:b0 (NSRect)i aRecti0 tab Returns the minimum size needed to display the NSCell.
fi-6552 fs16
fs28 fi-6552 {f3 -} (NSRect)b drawingRectForBounds:b0 (NSRect)i theRecti0 tab
s11 li7030 fi-6553 fi-5796 tab Returns the rectangle the NSCell draws in.
s9 li7029 fi-5794 fi-6552 fs16
fs28 fi-6552 {f3 -} (NSRect)b imageRectForBounds:b0 (NSRect)i theRecti0 tab Returns the rectangle that the cell'27s image is drawn in.
fi-6552 fs16
fs28 fi-6552 {f3 -} (NSRect)b titleRectForBounds:b0 (NSRect)i theRecti0 tab Returns the rectangle that the cell'27s title is drawn in.
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Setting the NSCell'27s Type
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (void)b setType:b0 (NSCellType)i aTypei0 tab Sets the NSCell'27s type to i aTypei0 .
fi-6552 fs16
fs28 fi-6552 {f3 -} (NSCellType)b typeb0 tab Returns the NSCell'27s type.
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Setting the NSCell'27s State
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (void)b setState:b0 (int)i valuei0 tab Sets the state of the NSCell to i valuei0 (0 or 1).
fi-6552 fs16
fs28 fi-6552 {f3 -} (int)b stateb0 tab Returns the state of the NSCell (0 or 1).
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Enabling and Disabling the NSCell
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (BOOL)b isEnabledb0 tab Returns whether the NSCell reacts to mouse events.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setEnabled:b0 (BOOL)i flagi0 tab Sets whether the NSCell reacts to mouse events.
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Setting the Image
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (NSImage *)b imageb0 tab Returns the NSCell'27s image.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setImage:b0 (NSImage *)i anImagei0 tab Makes i anImagei0 the NSCell'27s image.
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Setting the NSCell'27s Value
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (double)b doubleValueb0 tab Returns the NSCell'27s value as a b doubleb0 .
fi-6552 fs16
fs28 fi-6552 {f3 -} (float)b floatValueb0 tab Returns the NSCell'27s value as a b floatb0 .
fi-6552 fs16
fs28 fi-6552 {f3 -} (int)b intValueb0 tab Returns the NSCell'27s value as an b intb0 .
fi-6552 fs16
fs28 fi-6552 {f3 -} (NSString *)b stringValueb0 tab Returns the NSCell'27s value as a string.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setDoubleValue:b0 (double)i aDoublei0 tab Sets the NSCell'27s value to i aDoublei0 .
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setFloatValue:b0 (float)i aFloati0 tab Sets the NSCell'27s value to i aFloati0 .
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setIntValue:b0 (int)i anInti0 tab Sets the NSCell'27s value to i anInti0 .
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setStringValue:b0 (NSString *)i aStringi0 tab Sets the NSCell'27s value to a copy of i aStringi0 .
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Interacting with Other NSCells
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (void)b takeDoubleValueFrom:b0 (id)i senderi0 tab Sets the NSCell'27s value to i senderi0 '27s double floating-point value.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b takeFloatValueFrom:b0 (id)i senderi0 tab Sets the NSCell'27s value to i senderi0 '27s floating-point value.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b takeIntValueFrom:b0 (id)i senderi0 tab Sets the NSCell'27s value to i senderi0 '27s integer value.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b takeStringValueFrom:b0 (id)i senderi0 tab Sets the NSCell'27s value to i senderi0 '27s string value.
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Modifying Text Attributes
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (NSTextAlignment)b alignmentb0 tab Returns the alignment of text in the NSCell.
fi-6552 fs16
fs28 fi-6552 {f3 -} (NSFont *)b fontb0 tab Returns the Font used to display text in the NSCell.
fi-6552 fs16
fs28 fi-6552 {f3 -} (BOOL)b isEditableb0 tab Returns whether the NSCell'27s text is editable.
fi-6552 fs16
fs28 fi-6552 {f3 -} (BOOL)b isSelectableb0 tab Returns whether the NSCell'27s text is selectable.
fi-6552 fs16
fs28 fi-6552 {f3 -} (BOOL)b isScrollableb0 tab Returns whether the NSCell scrolls to follow typing.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setAlignment:b0 (NSTextAlignment)i modei0 tab Sets the alignment of text in the NSCell to i modei0 .
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setEditable:b0 (BOOL)i flagi0 tab Sets whether the NSCell'27s text is editable.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setFont:b0 (NSFont *)i fontObjecti0 tab Sets the Font used to display text in the NSCell to i fontObjecti0 .
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setSelectable:b0 (BOOL)i flagi0 tab Sets whether the NSCell'27s text is selectable.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setScrollable:b0 (BOOL)i flagi0 tab Sets whether the NSCell scrolls to follow typing.
fi-6552 fs16
fs28 fi-6552 {f3 -} (NSText *)b setUpFieldEditorAttributes:b0 (NSText *)i textObject
s11 li7030 fi-6553 fi-5796 i0 tab Sets NSText parameters for the field editor. (See the documentation for NSText.)
s9 li7029 fi-5794 fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setWraps:b0 (BOOL)i flagi0 tab Sets whether the NSCell'27s text is word-wrapped.
fi-6552 fs16
fs28 fi-6552 {f3 -} (BOOL)b wrapsb0 tab Returns whether the NSCell'27s text is word-wrapped.
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Editing Text
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (void)b editWithFrame:b0 (NSRect)i aRecti0 tab Allows text editing in response to a mouse-down event.
s11 li7030 fi-6553 fi-5796 b inView:b0 (NSView *)i controlViewi0 tab
b editor:b0 (NSText *)i textObjecti0 tab
b delegate:b0 (id)i anObjecti0 tab
b event:b0 (NSEvent *)i theEvent
s9 li7029 fi-5794 fi-6552 i0 fs16
fs28 fi-6552 {f3 -} (void)b endEditing:b0 (NSText *)i textObjecti0 tab Ends any text editing occurring in the NSCell.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b selectWithFrame:b0 (NSRect)i aRecti0 tab Allows text selection in response to a mouse-down event.
s11 li7030 fi-6553 fi-5796 b inView:b0 (NSView *)i controlViewi0 tab
b editor:b0 (NSText *)i textObjecti0 tab
b delegate:b0 (id)i anObjecti0 tab
b start:b0 (int)i selStarti0 tab
b length:b0 (int)i selLength
pard s19 li100 fi0 ri1007 ql f0 b i0 fs48
fs28 Validating Input
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (int)b entryTypeb0 tab Returns the type of data the user can type into the NSCell.
fi-6552 fs16
fs28 fi-6552 {f3 -} (BOOL)b isEntryAcceptable:b0 (NSString *)i aStringi0 tab Returns whether i aStringi0 is acceptable for the entry type.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setEntryType:b0 (int)i aTypei0 tab Sets the type of data the user can type into the NSCell.
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Formatting Data
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (void)b setFloatingPointFormat:b0 (BOOL)i autoRangei0 tab Sets the display format for floating-point values.
s11 li7030 fi-6553 fi-5796 b left:b0 (unsigned int)i leftDigits
i0 b right:b0 (unsigned int)i rightDigits
pard s19 li100 fi0 ri1007 ql f0 b i0 fs48
fs28 Modifying Graphic Attributes
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (BOOL)b isBezeledb0 tab Returns whether the NSCell has a bezeled border.
fi-6552 fs16
fs28 fi-6552 {f3 -} (BOOL)b isBorderedb0 tab Returns whether NSCell has a plain border.
fi-6552 fs16
fs28 fi-6552 {f3 -} (BOOL)b isOpaqueb0 tab Returns whether the NSCell is opaque.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setBezeled:b0 (BOOL)i flagi0 tab Sets whether the NSCell has a bezeled border.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setBordered:b0 (BOOL)i flagi0 tab Sets whether the NSCell has a plain border.
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Setting Parameters
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (int)b cellAttribute:b0 (NSCellAttribute)i aParameter
s11 li7030 fi-6553 fi-5796 i0 tab Returns various flag values.
s9 li7029 fi-5794 fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setCellAttribute:b0 (NSCellAttribute)i aParameteri0 tab
s11 li7030 fi-6553 fi-5796 b to:b0 (int)i valuei0 tab Sets various NSCell flags.
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Displaying
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (NSView *)b controlViewb0 tab Implemented by subclasses to return the NSView last drawn in (normally an NSControl).
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b drawInteriorWithFrame:b0 (NSRect)i cellFramei0 tab Draws the area within the NSCell'27s border in i controlView.
s11 li7030 fi-6553 fi-5796 i0 b inView:b0 (NSView *)i controlView
s9 li7029 fi-5794 fi-6552 i0 fs16
fs28 fi-6552 {f3 -} (void)b drawWithFrame:b0 (NSRect)i cellFramei0 tab Draws the entire NSCell in i controlView.i0
s11 li7030 fi-6553 fi-5796 b inView:b0 (NSView *)i controlView
s9 li7029 fi-5794 fi-6552 i0 fs16
fs28 fi-6552 {f3 -} (void)b highlight:b0 (BOOL)i liti0 tab If i liti0 is YES, highlights the NSCell in i controlViewi0 ,
s11 li7030 fi-6553 fi-5796 b withFrame:b0 (NSRect)i cellFramei0 tab tab otherwise unhighlights.
b inView:b0 (NSView *)i controlViewtab i0
s9 li7029 fi-5794 fi-6552 fs16
fs28 fi-6552 {f3 -} (BOOL)b isHighlightedb0 tab Returns whether the NSCell is highlighted.
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Target and Action
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (SEL)b actionb0 tab Implemented by subclasses to return the action method.
fi-6552 fs16
fs28 fi-6552 {f3 -} (BOOL)b isContinuousb0 tab Returns whether the NSCell continuously sends the action.
fi-6552 fs16
fs28 fi-6552 {f3 -} (int)b sendActionOn:b0 (int)i maski0 tab Determines when the action is sent while tracking.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setAction:b0 (SEL)i aSelectori0 tab Implemented by subclasses to set the action method.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setContinuous:b0 (BOOL)i flagi0 tab Sets whether the NSCell continuously sends the action.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b setTarget:b0 (id)i anObjecti0 tab Implemented by subclasses to set the target object.
fi-6552 fs16
fs28 fi-6552 {f3 -} (id)b targetb0 tab Implemented by subclasses to return the target object.
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Assigning a Tag
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (void)b setTag:b0 (int)i anInti0 tab Implemented by subclasses to set an identifier tag.
fi-6552 fs16
fs28 fi-6552 {f3 -} (int)b tagb0 tab Implemented by subclasses to return the identifier tag.
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Handling Keyboard Alternatives
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (NSString *)b keyEquivalentb0 tab Implemented by subclasses to return a key equivalent.
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Tracking the Mouse
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 + (BOOL)b prefersTrackingUntilMouseUpb0 tab Returns NO, so tracking stops when the mouse leaves the NSCell; subclasses may override.
fi-6552 fs16
fs28 fi-6552 {f3 -} (BOOL)b continueTracking:b0 (NSPoint)i lastPointi0 tab Returns whether tracking should continue based on
s11 li7030 fi-6553 fi-5796 b at:b0 (NSPoint)i currentPointi0 tab tab i lastPointi0 and i currentPointi0 within i controlViewi0 .
b inView:b0 (NSView *)i controlView
s9 li7029 fi-5794 fi-6552 i0 fs16
fs28 fi-6552 {f3 -} (int)b mouseDownFlagsb0 tab Returns the event flags set at the start of mouse tracking.
fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b getPeriodicDelay:b0 (float *)i delayi0 tab Returns repeat values for continuous sending of the action.
s11 li7030 fi-6553 fi-5796 b interval:b0 (float *)i interval
s9 li7029 fi-5794 fi-6552 i0 fs16
fs28 fi-6552 {f3 -} (BOOL)b startTrackingAt:b0 (NSPoint)i startPointi0 tab Determines whether tracking should begin based on
s11 li7030 fi-6553 fi-5796 b inView:b0 (NSView *)i controlViewi0 tab tab i startPointi0 within i controlViewi0 .
s9 li7029 fi-5794 fi-6552 fs16
fs28 fi-6552 {f3 -} (void)b stopTracking:b0 (NSPoint)i lastPointi0 tab Allows the NSCell to update itself to end tracking, based on
s11 li7030 fi-6553 fi-5796 b at:b0 (NSPoint)i stopPointi0 tab i tab lastPointi0 and i stopPointi0 within i controlViewi0 ; flag is YES
b inView:b0 (NSView *)i controlViewi0 tab tab if this method was invoked because the mouse went up.
b mouseIsUp:b0 (BOOL)i flagi0 tab
s9 li7029 fi-5794 fi-6552 fs16
fs28 fi-6552 {f3 -} (BOOL)b trackMouse:b0 (NSEvent *)i theEventi0 tab Tracks the mouse, returning YES if the mouse goes up
s11 li7030 fi-6553 fi-5796 b inRect:b0 (NSRect)i cellFramei0 tab tab while in i cellFramei0 . This method is usually invoked by
b ofView:b0 (NSView *)i controlViewi0 tab tab an NSControl'27s b mouseDown:b0 method, which passes
b untilMouseUp:b0 (BOOL)i flagi0 tab tab the mouse-down event in i theEventi0 . If i flagi0 is YES, the method keeps tracking until the mouse goes up; otherwise it tracks until the mouse leaves i cellFrame.i0
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Managing the Cursor
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (void)b resetCursorRect:b0 (NSRect)i cellFramei0 tab Sets text NSCells to show the I-beam cursor.
s11 li7030 fi-6553 fi-5796 b inView:b0 (NSView *)i controlView
pard s19 li100 fi0 ri1007 ql f0 b i0 fs48
fs28 Comparing to Another NSCell
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (NSComparisonResult)b compare:b0 (id)i otherCelli0 tab Compares the string values of this cell and i otherCelli0 (which must be a kind of NSCell). Raises NSBadComparisonException if i otherCelli0 is not of the NSCell class.
pard s19 li100 fi0 ri1007 ql f0 b fs48
fs28 Using the NSCell to Represent an Object
fs14
fs28 pard s9 li7029 fi-6552 ri1007 ql tx6652 tx7030 f1 b0 fs2
fs28 fi-6552 {f3 -} (id)b representedObjecttab b0 Returns the object that the receiver represents, if any.
fi-6552 fs16
fs28 fi-6552 b {f3 -} b0 (void)b setRepresentedObject:b0 (id)i anObjecttab i0 Creates an association between the receiver and i anObjecti0 .i anObjecti0 will be retained, released, archived, and unarchived whenever the receiver is. If another cell is already associated with i anObject, i0 that association is broken, and the receiver is associated with the object.
}These are the contents of the former NiCE NeXT User Group NeXTSTEP/OpenStep software archive, currently hosted by Netfuture.ch.