Up

NSCell

Authors

Scott Christley (scottc@net-community.com)
The abstract cell class

Copyright: (C) 1996 Free Software Foundation, Inc.


Contents -

  1. Software documentation for the NSCell class
  2. Software documentation for the NSCell(PrivateMethods) category

Software documentation for the NSCell class

NSCell : NSObject

Declared in:
AppKit/NSCell.h
Conforms to:
NSCopying
NSCoding
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


Instance Variables

Method summary

defaultMenu 

+ (NSMenu*) defaultMenu;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


prefersTrackingUntilMouseUp 

+ (BOOL) prefersTrackingUntilMouseUp;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


acceptsFirstResponder 

- (BOOL) acceptsFirstResponder;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


action 

- (SEL) action;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


alignment 

- (NSTextAlignment) alignment;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


allowsEditingTextAttributes 

- (BOOL) allowsEditingTextAttributes;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


allowsMixedState 

- (BOOL) allowsMixedState;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


attributedStringValue 

- (NSAttributedString*) attributedStringValue;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


calcDrawInfo: 

- (void) calcDrawInfo: (NSRect)aRect;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


cellAttribute: 

- (int) cellAttribute: (NSCellAttribute)aParameter;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


cellSize 

- (NSSize) cellSize;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


cellSizeForBounds: 

- (NSSize) cellSizeForBounds: (NSRect)aRect;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


compare: 

- (NSComparisonResult) compare: (id)otherCell;
Availability: Not in OpenStep/MacOS-X

Compares the reciever to another to another NSCell. The argument must be an NSCell sublclass and have the NSCellType NSTextCellType. Returns the result of the comparison of each cell's stringValue.


continueTracking: at: inView: 

- (BOOL) continueTracking: (NSPoint)lastPoint at: (NSPoint)currentPoint inView: (NSView*)controlView;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


controlSize 

- (NSControlSize) controlSize;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


controlTint 

- (NSControlTint) controlTint;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


controlView 

- (NSView*) controlView;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


doubleValue 

- (double) doubleValue;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


drawInteriorWithFrame: inView: 

- (void) drawInteriorWithFrame: (NSRect)cellFrame inView: (NSView*)controlView;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


drawWithFrame: inView: 

- (void) drawWithFrame: (NSRect)cellFrame inView: (NSView*)controlView;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


drawingRectForBounds: 

- (NSRect) drawingRectForBounds: (NSRect)theRect;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


editWithFrame: inView: editor: delegate: event: 

- (void) editWithFrame: (NSRect)aRect inView: (NSView*)controlView editor: (NSText*)textObject delegate: (id)anObject event: (NSEvent*)theEvent;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


endEditing: 

- (void) endEditing: (NSText*)textObject;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


entryType 

- (int) entryType;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


floatValue 

- (float) floatValue;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


font 

- (NSFont*) font;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


formatter 

- (id) formatter;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


getPeriodicDelay: interval: 

- (void) getPeriodicDelay: (float*)delay interval: (float*)interval;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


hasValidObjectValue 

- (BOOL) hasValidObjectValue;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


highlight: withFrame: inView: 

- (void) highlight: (BOOL)lit withFrame: (NSRect)cellFrame inView: (NSView*)controlView;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


highlightColorWithFrame: inView: 

- (NSColor*) highlightColorWithFrame: (NSRect)cellFrame inView: (NSView*)controlView;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


image 

- (NSImage*) image;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


imageRectForBounds: 

- (NSRect) imageRectForBounds: (NSRect)theRect;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


importsGraphics 

- (BOOL) importsGraphics;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


initImageCell: 

- (id) initImageCell: (NSImage*)anImage;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


initTextCell: 

- (id) initTextCell: (NSString*)aString;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


intValue 

- (int) intValue;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


isBezeled 

- (BOOL) isBezeled;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


isBordered 

- (BOOL) isBordered;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


isContinuous 

- (BOOL) isContinuous;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


isEditable 

- (BOOL) isEditable;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


isEnabled 

- (BOOL) isEnabled;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


isEntryAcceptable: 

- (BOOL) isEntryAcceptable: (NSString*)aString;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


isHighlighted 

- (BOOL) isHighlighted;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


isOpaque 

- (BOOL) isOpaque;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


isScrollable 

- (BOOL) isScrollable;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


isSelectable 

- (BOOL) isSelectable;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


keyEquivalent 

- (NSString*) keyEquivalent;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


menu 

- (NSMenu*) menu;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


menuForEvent: inRect: ofView: 

- (NSMenu*) menuForEvent: (NSEvent*)anEvent inRect: (NSRect)cellFrame ofView: (NSView*)aView;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


mnemonic 

- (NSString*) mnemonic;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


mnemonicLocation 

- (unsigned int) mnemonicLocation;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


mouseDownFlags 

- (int) mouseDownFlags;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


nextState 

- (int) nextState;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


objectValue 

- (id) objectValue;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


performClick: 

- (void) performClick: (id)sender;
Availability: Not in OpenStep/MacOS-X

Simulates a single click in the cell (only works with controls which have no more than one cell). This method is deprecated, performClickWithFrame:inView: is the right method to use now.


performClickWithFrame: inView: 

- (void) performClickWithFrame: (NSRect)cellFrame inView: (NSView*)controlView;
Availability: Not in OpenStep/MacOS-X

Simulates a single click in the cell. The display of the cell with this event occurs in the area delimited by cellFrame within controlView.


refusesFirstResponder 

- (BOOL) refusesFirstResponder;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


representedObject 

- (id) representedObject;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


resetCursorRect: inView: 

- (void) resetCursorRect: (NSRect)cellFrame inView: (NSView*)controlView;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


selectWithFrame: inView: editor: delegate: start: length: 

- (void) selectWithFrame: (NSRect)aRect inView: (NSView*)controlView editor: (NSText*)textObject delegate: (id)anObject start: (int)selStart length: (int)selLength;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


sendActionOn: 

- (int) sendActionOn: (int)mask;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


sendsActionOnEndEditing 

- (BOOL) sendsActionOnEndEditing;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setAction: 

- (void) setAction: (SEL)aSelector;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setAlignment: 

- (void) setAlignment: (NSTextAlignment)mode;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setAllowsEditingTextAttributes: 

- (void) setAllowsEditingTextAttributes: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setAllowsMixedState: 

- (void) setAllowsMixedState: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setAttributedStringValue: 

- (void) setAttributedStringValue: (NSAttributedString*)attribStr;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setBezeled: 

- (void) setBezeled: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setBordered: 

- (void) setBordered: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setCellAttribute: to: 

- (void) setCellAttribute: (NSCellAttribute)aParameter to: (int)value;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setContinuous: 

- (void) setContinuous: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setControlSize: 

- (void) setControlSize: (NSControlSize)controlSize;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setControlTint: 

- (void) setControlTint: (NSControlTint)controlTint;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setDoubleValue: 

- (void) setDoubleValue: (double)aDouble;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setEditable: 

- (void) setEditable: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setEnabled: 

- (void) setEnabled: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setEntryType: 

- (void) setEntryType: (int)aType;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setFloatValue: 

- (void) setFloatValue: (float)aFloat;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setFloatingPointFormat: left: right: 

- (void) setFloatingPointFormat: (BOOL)autoRange left: (unsigned int)leftDigits right: (unsigned int)rightDigits;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setFont: 

- (void) setFont: (NSFont*)fontObject;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setFormatter: 

- (void) setFormatter: (NSFormatter*)newFormatter;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setHighlighted: 

- (void) setHighlighted: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setImage: 

- (void) setImage: (NSImage*)anImage;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setImportsGraphics: 

- (void) setImportsGraphics: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setIntValue: 

- (void) setIntValue: (int)anInt;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setMenu: 

- (void) setMenu: (NSMenu*)aMenu;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setMnemonicLocation: 

- (void) setMnemonicLocation: (unsigned int)location;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setNextState 

- (void) setNextState;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setObjectValue: 

- (void) setObjectValue: (id)object;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setRefusesFirstResponder: 

- (void) setRefusesFirstResponder: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setRepresentedObject: 

- (void) setRepresentedObject: (id)anObject;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setScrollable: 

- (void) setScrollable: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setSelectable: 

- (void) setSelectable: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setSendsActionOnEndEditing: 

- (void) setSendsActionOnEndEditing: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setShowsFirstResponder: 

- (void) setShowsFirstResponder: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setState: 

- (void) setState: (int)value;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setStringValue: 

- (void) setStringValue: (NSString*)aString;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setTag: 

- (void) setTag: (int)anInt;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setTarget: 

- (void) setTarget: (id)anObject;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setTitle: 

- (void) setTitle: (NSString*)aString;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setTitleWithMnemonic: 

- (void) setTitleWithMnemonic: (NSString*)aString;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setType: 

- (void) setType: (NSCellType)aType;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setUpFieldEditorAttributes: 

- (NSText*) setUpFieldEditorAttributes: (NSText*)textObject;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


setWraps: 

- (void) setWraps: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


showsFirstResponder 

- (BOOL) showsFirstResponder;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


startTrackingAt: inView: 

- (BOOL) startTrackingAt: (NSPoint)startPoint inView: (NSView*)controlView;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


state 

- (int) state;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


stopTracking: at: inView: mouseIsUp: 

- (void) stopTracking: (NSPoint)lastPoint at: (NSPoint)stopPoint inView: (NSView*)controlView mouseIsUp: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


stringValue 

- (NSString*) stringValue;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


tag 

- (int) tag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


takeDoubleValueFrom: 

- (void) takeDoubleValueFrom: (id)sender;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


takeFloatValueFrom: 

- (void) takeFloatValueFrom: (id)sender;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


takeIntValueFrom: 

- (void) takeIntValueFrom: (id)sender;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


takeObjectValueFrom: 

- (void) takeObjectValueFrom: (id)sender;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


takeStringValueFrom: 

- (void) takeStringValueFrom: (id)sender;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


target 

- (id) target;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


title 

- (NSString*) title;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


titleRectForBounds: 

- (NSRect) titleRectForBounds: (NSRect)theRect;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


trackMouse: inRect: ofView: untilMouseUp: 

- (BOOL) trackMouse: (NSEvent*)theEvent inRect: (NSRect)cellFrame ofView: (NSView*)controlView untilMouseUp: (BOOL)flag;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


type 

- (NSCellType) type;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.


wraps 

- (BOOL) wraps;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.




Instance Variables for NSCell Class

_action_mask

@protected unsigned int _action_mask;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.


_cell

@protected struct GSCellFlagsType _cell;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.


_cell_image

@protected NSImage* _cell_image;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.


_contents

@protected NSString* _contents;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.


_font

@protected NSFont* _font;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.


_formatter

@protected NSFormatter* _formatter;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.


_menu

@protected NSMenu* _menu;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.


_mnemonic_location

@protected unsigned char _mnemonic_location;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.


_mouse_down_flags

@protected unsigned int _mouse_down_flags;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.


_objectValue

@protected id _objectValue;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.


_represented_object

@protected id _represented_object;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.





Software documentation for the NSCell(PrivateMethods) category

NSCell(PrivateMethods)

Declared in:
AppKit/NSCell.h
Availability: Not in OpenStep/MacOS-X

Warning this category is private, which means that the methods are for internal use by the package. You should not use them in external code.

Method summary

_drawAttributedText: inFrame: 

- (void) _drawAttributedText: (NSAttributedString*)aString inFrame: (NSRect)aRect;
Availability: Not in OpenStep/MacOS-X

Warning the underscore at the start of the name of this method indicates that it is private, for internal use only, and you should not use the method in your code.
Private internal method to display an attributed string.
Important: text should always be vertically centered without considering descender [as if descender did not exist]. This is particularly important for single line texts. Please make sure the output remains always correct.


_drawText: inFrame: 

- (void) _drawText: (NSString*)aString inFrame: (NSRect)cellFrame;
Availability: Not in OpenStep/MacOS-X

Warning the underscore at the start of the name of this method indicates that it is private, for internal use only, and you should not use the method in your code.
Important: text should always be vertically centered without considering descender [as if descender did not exist]. This is particularly important for single line texts. Please make sure the output remains always correct.


_nonAutoreleasedTypingAttributes 

- (NSDictionary*) _nonAutoreleasedTypingAttributes;
Availability: Not in OpenStep/MacOS-X

Warning the underscore at the start of the name of this method indicates that it is private, for internal use only, and you should not use the method in your code.


_sendsActionOn: 

- (BOOL) _sendsActionOn: (int)eventTypeMask;
Availability: Not in OpenStep/MacOS-X

Warning the underscore at the start of the name of this method indicates that it is private, for internal use only, and you should not use the method in your code.


_sizeText: 

- (NSSize) _sizeText: (NSString*)title;
Availability: Not in OpenStep/MacOS-X

Warning the underscore at the start of the name of this method indicates that it is private, for internal use only, and you should not use the method in your code.


textColor 

- (NSColor*) textColor;
Availability: Not in OpenStep/MacOS-X

Description forthcoming.



Up