NSCell Class Reference
| Inherits from | |
| Conforms to | |
| Framework | /System/Library/Frameworks/AppKit.framework |
| Availability | Available in OS X v10.0 and later. |
| Companion guide | |
| Declared in | NSCell.h |
Overview
The NSCell class provides a mechanism for displaying text or images in an NSView object without the overhead of a full NSView subclass. It’s used heavily by most of the NSControl classes to implement their internal workings.
Designated Initializers
When subclassing NSCell you must implement all of the designated initializers. Those methods are: init, initWithCoder:, initTextCell:, and initImageCell:.
Tasks
Initializing a Cell
Managing Cell Values
-
– setObjectValue: -
– objectValue -
– hasValidObjectValue -
– setIntValue: -
– intValue -
– setIntegerValue: -
– integerValue -
– setStringValue: -
– stringValue -
– setDoubleValue: -
– doubleValue -
– setFloatValue: -
– floatValue
Managing Cell Attributes
-
– setCellAttribute:to: -
– cellAttribute: -
– setType: -
– type -
– setEnabled: -
– isEnabled -
– allowsUndo -
– setAllowsUndo:
Managing Display Attributes
-
– setBezeled: -
– isBezeled -
– setBordered: -
– isBordered -
– isOpaque -
– setControlTint: -
– controlTint -
– setBackgroundStyle: -
– backgroundStyle -
– interiorBackgroundStyle
Managing Cell State
Modifying Textual Attributes
-
– setEditable: -
– isEditable -
– setSelectable: -
– isSelectable -
– setScrollable: -
– isScrollable -
– setAlignment: -
– alignment -
– setFont: -
– font -
– lineBreakMode -
– setLineBreakMode: -
– truncatesLastVisibleLine -
– setTruncatesLastVisibleLine: -
– setWraps: -
– wraps -
– baseWritingDirection -
– setBaseWritingDirection: -
– setAttributedStringValue: -
– attributedStringValue -
– setAllowsEditingTextAttributes: -
– allowsEditingTextAttributes -
– setImportsGraphics: -
– importsGraphics -
– setUpFieldEditorAttributes: -
– title -
– setTitle:
Managing the Target and Action
Managing the Image
Managing the Tag
Formatting and Validating Data
-
– setFormatter: -
– formatter -
– entryTypeDeprecated in OS X v10.0 and later -
– setEntryType:Deprecated in OS X v10.0 and later -
– isEntryAcceptable:Deprecated in OS X v 10.0 and later -
– setFloatingPointFormat:left:right:Deprecated in OS X v10.0
Managing Menus
Comparing Cells
Respond to Keyboard Events
-
– acceptsFirstResponder -
– setShowsFirstResponder: -
– showsFirstResponder -
– refusesFirstResponder -
– setRefusesFirstResponder: -
– performClick: -
– mnemonicDeprecated in OS X v10.8 -
– mnemonicLocationDeprecated in OS X v10.8 -
– setMnemonicLocation:Deprecated in OS X v10.8 -
– setTitleWithMnemonic:Deprecated in OS X v10.8
Deriving Values
-
– takeObjectValueFrom: -
– takeIntegerValueFrom: -
– takeIntValueFrom: -
– takeStringValueFrom: -
– takeDoubleValueFrom: -
– takeFloatValueFrom:
Representing an Object
Tracking the Mouse
-
– trackMouse:inRect:ofView:untilMouseUp: -
– startTrackingAt:inView: -
– continueTracking:at:inView: -
– stopTracking:at:inView:mouseIsUp: -
– mouseDownFlags -
+ prefersTrackingUntilMouseUp -
– getPeriodicDelay:interval:
Hit Testing
Managing the Cursor
Handling Keyboard Alternatives
Dragging Cells
Managing Focus Rings
-
– drawFocusRingMaskWithFrame:inView: -
– focusRingMaskBoundsForFrame:inView: -
+ defaultFocusRingType -
– setFocusRingType: -
– focusRingType
Determining Cell Size
-
– calcDrawInfo: -
– cellSize -
– cellSizeForBounds: -
– drawingRectForBounds: -
– imageRectForBounds: -
– titleRectForBounds: -
– controlSize -
– setControlSize:
Drawing and Highlighting
-
– drawWithFrame:inView: -
– highlightColorWithFrame:inView: -
– drawInteriorWithFrame:inView: -
– controlView -
– setControlView: -
– highlight:withFrame:inView: -
– setHighlighted: -
– isHighlighted
Editing and Selecting Text
-
– editWithFrame:inView:editor:delegate:event: -
– selectWithFrame:inView:editor:delegate:start:length: -
– sendsActionOnEndEditing -
– setSendsActionOnEndEditing: -
– endEditing: -
– wantsNotificationForMarkedText -
– fieldEditorForView: -
– usesSingleLineMode -
– setUsesSingleLineMode:
Managing Expansion Frames
User Interface Layout Direction
Class Methods
defaultFocusRingType
Returns the default type of focus ring for the receiver.
Return Value
The default type of focus ring for the receiver (one of the values listed in NSFocusRingType).
Availability
- Available in OS X v10.3 and later.
Declared In
NSCell.hdefaultMenu
Returns the default menu for instances of the receiver.
Return Value
The default menu. The NSCell implementation of this method returns nil.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hprefersTrackingUntilMouseUp
Returns a Boolean value that indicates whether tracking stops when the cursor leaves the cell.
Return Value
YES if tracking stops when the cursor leaves the cell, otherwise NO.
Discussion
The default implementation returns NO. Subclasses may override this method to return a different value.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hInstance Methods
acceptsFirstResponder
Returns a Boolean value that indicates whether the receiver accepts first responder status.
Return Value
YES if the receiver can become the first responder, otherwise NO.
Discussion
The default value is YES if the receiver is enabled. Subclasses may override this method to return a different value.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.haction
Returns the default action-message selector associated with the cell.
Return Value
The selector associated with the cell. The NSCell implementation of this method returns NULL by default.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.halignment
Returns the alignment of text in the receiver.
Return Value
The alignment of text in the receiver (one of the following constants: NSLeftTextAlignment, NSRightTextAlignment,NSCenterTextAlignment, NSJustifiedTextAlignment, NSNaturalTextAlignment).
Discussion
The default value is NSNaturalTextAlignment.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hallowsEditingTextAttributes
Returns a Boolean value that indicates whether the receiver allows user editing of textual attributes.
Return Value
YES if the receiver allows the user to edit textual attributes of the cell's text, otherwise NO.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hallowsMixedState
Returns a Boolean value that indicates whether the receiver supports three states.
Return Value
YES if the receiver supports all three states (on, off, and mixed), otherwise NO (the receiver supports only the on and off states).
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hallowsUndo
Returns a Boolean value that indicates whether the receiver assumes responsibility for undo operations.
Return Value
YES if the receiver handles undo operations, otherwise NO.
Discussion
By default, the NSTextFieldCell class uses this feature to handle undo operations for edited text. Other controls set a value that is appropriate for their implementation.
Availability
- Available in OS X v10.4 and later.
See Also
Declared In
NSCell.hattributedStringValue
Returns the value of the receiver’s cell as an attributed string using the receiver's formatter object (if one exists).
Return Value
The value of the cell interpreted as an attributed string.
Discussion
The textual attributes are the default paragraph style, the receiver’s font and alignment, and whether the receiver is enabled and scrollable.
For OS X v10.3 and later: If you use a class that responds to the selector attributedStringValue for the object value of a cell, then the cell will use that method to fetch the string to draw rather than using stringValue.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hbackgroundStyle
Returns the background style for the receiver.
Return Value
The background style for the receiver.
Discussion
The background describes the surface the cell is drawn onto in drawWithFrame:inView:. A control typically sets this before it asks the cell to draw. A cell may draw differently based on background characteristics. For example, a tableview drawing a cell in a selected row might call [cell setBackgroundStyle:NSBackgroundStyleDark]. A text cell might decide to render its text white as a result. A rating-style level indicator might draw its stars white instead of gray.
Availability
- Available in OS X v10.5 and later.
Declared In
NSCell.hbaseWritingDirection
Returns the initial writing direction used to determine the actual writing direction for text.
Return Value
The initial writing direction the receiver uses to determine the actual writing direction for text. See NSWritingDirection for possible values.
Discussion
The default value is NSWritingDirectionNatural.
The Text system uses this value as a hint for calculating the actual direction for displaying Unicode characters. You should not need to call this method directly.
Availability
- Available in OS X v10.4 and later.
See Also
Declared In
NSCell.hcalcDrawInfo:
Recalculates the cell geometry.
Parameters
- aRect
The reference rectangle to use when calculating the cell information.
Discussion
Objects (such as controls) that manage NSCell objects generally maintain a flag that informs them if any of their cells have been modified in such a way that the location or size of the cell should be recomputed. If so, calcSize method of NSControl is automatically invoked prior to the display of the cell, and that method invokes the calcDrawInfo: method of the cell.
The default implementation of this method does nothing.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hcellAttribute:
Returns the value for the specified cell attribute.
Parameters
- aParameter
The cell attribute whose value you want to get. Attributes include the receiver's current state and whether it is disabled, editable, or highlighted.
Return Value
The value for the cell attribute specified by aParameter.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hcellSize
Returns the minimum size needed to display the receiver.
Return Value
The size of the cell, or the size (10000, 10000) if the receiver is not a text or image cell. If the cell is an image cell but no image has been set, returns NSZeroSize.
Discussion
This method takes into account of the size of the image or text within a certain offset determined by the border type of the cell.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hcellSizeForBounds:
Returns the minimum size needed to display the receiver, constraining it to the specified rectangle.
Parameters
- aRect
The size of the cell, or the size of the
aRectparameter if the cell is not a text or image cell. If the cell is an image cell but no image has been set, returnsNSZeroSize.
Discussion
This method takes into account of the size of the image or text within a certain offset determined by the border type of the cell. If the receiver is of text type, the text is resized to fit within aRect (as much as aRect is within the bounds of the cell).
To support constraint-based layout, when the content of a custom cell changes in such a way that the return value of this method would change, it needs to notify its control of the change via invalidateIntrinsicContentSizeForCell:.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hcompare:
Compares the string values of the receiver another cell, disregarding case.
Parameters
- otherCell
The cell to compare against the receiver. This parameter must be of type
NSCell; if it is not, this method raisesNSBadComparisonException.This value must not be
nil. If the value isnil, the behavior is undefined and may change in future versions of OS X.
Return Value
NSOrderedAscending if the string value of the receiver precedes the string value of otherCell in lexical ordering, NSOrderedSame if the string values are equivalent in lexical value, and NSOrderedDescending string value of the receiver follows the string value of otherCell in lexical ordering.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hcontinueTracking:at:inView:
Returns a Boolean value that indicates whether mouse tracking should continue in the receiving cell.
Parameters
- lastPoint
Contains either the initial location of the cursor when tracking began or the previous current point.
- currentPoint
The current location of the cursor.
- controlView
The
NSControlobject managing the receiver.
Return Value
YES if mouse tracking should continue, otherwise NO.
Discussion
This method is invoked in trackMouse:inRect:ofView:untilMouseUp:. The default implementation returns YES if the cell is set to continuously send action messages to its target when the mouse button is down or the mouse is being dragged. Subclasses can override this method to provide more sophisticated tracking behavior.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hcontrolSize
Returns the size of the receiver.
Return Value
A value that specifies the size of the receiver (for possible values, see “NSControlSize”).
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hcontrolTint
Returns the receiver’s control tint.
Return Value
An Designated Initializers value that specifies the tint of the receiver.).
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hcontrolView
Returns the receiver's control.
Return Value
The view (normally an NSControl object) associated with this cell. The default implementation returns nil.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hdoubleValue
Returns the value of the receiver’s cell as a double-precision floating-point number.
Return Value
The value of the cell interpreted as a double-precision floating-point number. If the receiver is not a text-type cell or the cell value is not scannable, returns 0.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hdraggingImageComponentsWithFrame:inView:
Generates dragging image components with the specified frame in the view.
Parameters
- frame
The bounding rectangle of the receiver.
- view
The view that manages the cell.
Return Value
An array of NSDraggingImageComponent objects representing the cell.
Discussion
The default implementation generates an image from the cell and return two components: one for NSDraggingImageComponentLabelKey and another for NSDraggingImageComponentIconKey. This is done by capturing the portion from titleRectForBounds: and imageRectForBounds: respectively.
This method can be subclassed and overridden to provide a custom set of NSDraggingImageComponent to create the drag image for the cell. This method is generally used by NSTableView/NSOutlineView.
Availability
- Available in OS X v10.7 and later.
Declared In
NSCell.hdrawFocusRingMaskWithFrame:inView:
Draws the focus ring for the control.
Parameters
- cellFrame
The bounding rectangle of the receiver, or a portion of the bounding rectangle.
- controlView
The view that manages the cell.
Discussion
Implemented by NSCell subclasses to draw the appropriate focus ring for the control The default implementation does nothing.
The Application Kit automatically invokes this method when appropriate, to render the view's focus ring. The view must be eligible to become its window's firstResponder, by overriding acceptsFirstResponder returning YES.
The focus ring is rendered using the style specified by the view's focusRingType, which must not be NSFocusRingTypeNone unless you want to suppress drawing of the focus ring. An implementation of drawFocusRingMaskWithFrame:inView: can assume that it is drawing in the view's bounds, and that the fill and stroke colors have been set to an arbitrary fully opaque color. It needs only draw the desired focus ring shape or an image or other object whose outline defines the focus ring mask.
This new OS X v10.7 focus ring API should no longer call NSSetFocusRingStyle() and perform it's own drawing.
Availability
- Available in OS X v10.7 and later.
Declared In
NSCell.hdrawingRectForBounds:
Returns the rectangle within which the receiver draws itself
Parameters
- theRect
The bounding rectangle of the receiver.
Return Value
The rectangle in which the receiver draws itself. This rectangle is slightly inset from the one in theRect.
Availability
- Available in OS X v10.0 and later.
See Also
-
calcSize(NSControl)
Declared In
NSCell.hdrawInteriorWithFrame:inView:
Draws the interior portion of the receiver, which includes the image or text portion but does not include the border.
Parameters
- cellFrame
The bounding rectangle of the receiver, or a portion of the bounding rectangle.
- controlView
The control that manages the cell.
Discussion
Text-type NSCell objects display their contents in a rectangle slightly inset from cellFrame using a global NSText object. Image-type NSCell objects display their contents centered within cellFrame. If the proper attributes are set, this method also displays the dotted-line rectangle to indicate if the control is the first responder and highlights the cell. This method is invoked from the drawCellInside: method of NSControl to visually update what the cell displays when its contents change. The drawing done by the NSCell implementation is minimal and becomes more complex in objects such as NSButtonCell and NSSliderCell.
This method draws the cell in the currently focused view, which can be different from the controlView passed in. Taking advantage of this is not recommended.
Subclasses often override this method to provide more sophisticated drawing of cell contents. Because drawWithFrame:inView: invokes drawInteriorWithFrame:inView: after it draws the cell's border, do not invoke drawWithFrame:inView: in your override implementation.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hdrawWithExpansionFrame:inView:
Instructs the receiver to draw in an expansion frame.
Parameters
- cellFrame
The frame in which to draw.
- view
The view in which to draw. This view may be different from the original view that the cell appeared in.
Discussion
This method allows the cell to perform custom expansion tool tip drawing. By default, NSCell simply calls drawWithFrame:inView:.
Availability
- Available in OS X v10.5 and later.
See Also
Declared In
NSCell.hdrawWithFrame:inView:
Draws the receiver’s border and then draws the interior of the cell.
Parameters
- cellFrame
The bounding rectangle of the receiver.
- controlView
The control that manages the cell.
Discussion
This method draws the cell in the currently focused view, which can be different from the controlView passed in. Taking advantage of this behavior is not recommended, however.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.heditWithFrame:inView:editor:delegate:event:
Begins editing of the receiver’s text using the specified field editor.
Parameters
- aRect
The bounding rectangle of the cell.
- controlView
The control that manages the cell.
- textObj
The field editor to use for editing the cell.
- anObject
The object to use as a delegate for the field editor (
textObjparameter). This delegate object receives variousNSTextdelegation and notification methods during the course of editing the cell's contents.- theEvent
The
NSLeftMouseDownevent that initiated the editing behavior.
Discussion
If the receiver isn’t a text-type NSCell object, no editing is performed. Otherwise, the field editor (textObj) is sized to aRect and its superview is set to controlView, so it exactly covers the receiver. The field editor is then activated and editing begins. It’s the responsibility of the delegate to end editing when responding to textShouldEndEditing:. Upon ending the editing session, the delegate should remove any data from the field editor.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hendEditing:
Ends the editing of text in the receiver using the specified field editor.
Parameters
- textObj
The field editor currently handling the editing of the cell's content.
Discussion
Ends any editing of text that began with a call to editWithFrame:inView:editor:delegate:event: or selectWithFrame:inView:editor:delegate:start:length:.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hexpansionFrameWithFrame:inView:
Returns the expansion cell frame for the receiver.
Parameters
- cellFrame
The frame for the receiver.
- view
The view in which the receiver will be drawn.
Return Value
The expansion cell frame for the receiver. If the frame is not too small, return an empty rect (NSZeroRect), and no expansion tool tip view will be shown.
Discussion
This method allows the cell to return an expansion cell frame if cellFrame is too small for the entire contents in the view. When the mouse is hovered over the cell in certain controls, the full cell contents are shown in a special floating tool tip view. By default, NSCell returns NSZeroRect, while some subclasses (such as NSTextFieldCell) will return the proper frame when required.
Availability
- Available in OS X v10.5 and later.
See Also
Declared In
NSCell.hfieldEditorForView:
Returns a custom field editor for editing in the view.
Parameters
- aControlView
The view containing cells that require a custom field editor.
Return Value
A custom field editor. The field editor must have isFieldEditor set to YES.
Discussion
This is an override point for NSCell subclasses designed to use their own custom field editors. This message is sent to the selected cell of aControlView using the NSWindow method in fieldEditor:forObject:.
Returning non-nil from this method indicates skipping the standard field editor querying processes including windowWillReturnFieldEditor:toObject: delegation.
The default implementation returns nil.
Availability
- Available in OS X v10.6 and later.
Declared In
NSCell.hfloatValue
Returns the value of the receiver’s cell as a single-precision floating-point number.
Return Value
The value of the cell interpreted as a single-precision floating-point number. If the receiver is not a text-type cell or the cell value is not scannable, returns 0.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hfocusRingMaskBoundsForFrame:inView:
Returns the bounds of the focus ring mask.
Parameters
- cellFrame
The bounding rectangle of the receiver, or a portion of the bounding rectangle.
- controlView
The view that manages the cell.
Return Value
Returns a rectangle encompassing the focus ring bounds in the controlView coordinate space.
Discussion
Implemented by NSCell subclasses to allow the cell to provide the rectangular bounds of the focus ring mask for the cell.
The default implementation returns an empty value. Subclasses are expected to implement this method if they intend to draw a focus ring.
Availability
- Available in OS X v10.7 and later.
Declared In
NSCell.hfocusRingType
Returns the type of focus ring currently set for the receiver.
Return Value
The type of focus ring currently set for the receiver (one of the values listed in NSFocusRingType).
Discussion
You can disable a view's focus ring drawing by overriding this method so it always returns NSFocusRingTypeNone, or by calling setFocusRingType: with NSFocusRingTypeNone. You should only disable a view from drawing its focus ring if you want to draw your own focus ring, or if there isn't sufficient space to display a focus ring in the default location.
Availability
- Available in OS X v10.3 and later.
Declared In
NSCell.hfont
Returns the font used to display text in the receiver
Return Value
The receiver's current font, or nil if the receiver is not a text-type cell.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hformatter
Returns the receiver's formatter object.
Return Value
An object of type NSFormatter used to format the receiver's content.
Discussion
The returned object handles translation of the receiver’s contents between its onscreen representation and its object value.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hgetPeriodicDelay:interval:
Returns the initial delay and repeat values for continuous sending of action messages to target objects.
Parameters
- delay
On input, a pointer to a floating-point variable. On output, the variable contains the current delay (measured in seconds) before messages are sent. This parameter must not be
NULL.- interval
On input, a pointer to a floating point variable. On output, the variable contains the interval (measured in seconds) at which messages are sent. This parameter must not be
NULL.
Discussion
The default implementation returns a delay of 0.2 and an interval of 0.025 seconds. Subclasses can override this method to supply their own delay and interval values.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hhasValidObjectValue
Returns a Boolean value that indicates whether the receiver has a valid object value.
Return Value
YES if the cell has a valid object value, otherwise NO.
Discussion
A valid object value is one that the receiver's formatter can "understand." Objects are always assumed to be valid unless they are rejected by the formatter. Invalid objects can still be accepted by the delegate of the receiver’s NSControl object (using the control:didFailToFormatString:errorDescription: delegate method).
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hhighlight:withFrame:inView:
Redraws the receiver with the specified highlight setting.
Parameters
- flag
If
YES, the cell is redrawn with a highlight; otherwise, ifNO, the highlight is removed.- cellFrame
The bounding rectangle of the receiver.
- controlView
The control that manages the cell.
Discussion
Note that the NSCell highlighting does not appear when highlighted cells are printed (although instances of NSTextFieldCell, NSButtonCell, and others can print themselves highlighted). Generally, you cannot depend on highlighting being printed because implementations of this method may choose (or not choose) to use transparency.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hhighlightColorWithFrame:inView:
Returns the color the receiver uses when drawing the selection highlight.
Parameters
- cellFrame
The bounding rectangle of the receiver.
- controlView
The control that manages the cell.
Return Value
The color the receiver uses when drawing the selection highlight.
Discussion
You should not assume that a cell would necessarily want to draw itself with the value returned from selectedControlColor. A cell may wish to draw with different a selection highlight color depending on such things as the key state of its controlView.
Availability
- Available in OS X v10.1 and later.
Declared In
NSCell.hhitTestForEvent:inRect:ofView:
Returns hit testing information for the receiver.
Parameters
- event
The current event.
- cellFrame
The cell’s frame.
- controlView
The control object in which the cell is located.
Return Value
A constant that specifies the type of area in which the event occurred—see “Hit Testing” for values.
Discussion
You can use a bit-wise mask to look for a specific value when calling this method—see “Hit Testing” for values.
Generally, this method should be overridden by custom NSCell subclasses to return the correct result. Currently, it is called by some multi-cell views, such as NSTableView.
By default, NSCell looks at the cell type and does the following:
NSImageCellType: If the image exists and the event point is in the image returnsNSCellHitContentArea, otherwiseNSCellHitNone.NSTextCellType(also applies toNSTextFieldCell):If there is text: If the event point hits in the text, return
NSCellHitContentArea. Additionally, if the cell is enabled returnNSCellHitContentArea|NSCellHitEditableTextArea.If there is not text: return
NSCellHitNone.NSNullCellType(this is the default that applies to non text or image cells who don't overridehitTestForEvent:inRect:ofView:):Return
NSCellHitContentAreaby default;If the cell not disabled, and it would track, return
NSCellHitContentArea|NSCellHitTrackableArea.
Availability
- Available in OS X v10.5 and later.
Declared In
NSCell.himage
Returns the image displayed by the receiver (if any).
Return Value
The image displayed by the receiver, or nil if the receiver is not an image-type cell.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.himageRectForBounds:
Returns the rectangle in which the receiver draws its image.
Parameters
- theRect
The bounding rectangle of the receiver.
Return Value
The rectangle in which the receiver draws its image. This rectangle is slightly offset from the one in theRect.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.himportsGraphics
Returns a Boolean value that indicates whether the text of the receiver can contain imported graphics.
Return Value
YES if the receiver's text is in the RTFD format and supports imported graphics, otherwise NO.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hinitImageCell:
Returns an NSCell object initialized with the specified image and set to have the cell’s default menu.
Parameters
- anImage
The image to use for the cell. If this parameter is
nil, no image is set.
Return Value
An initialized NSCell object, or nil if the cell could not be initialized.
Discussion
This is one of four designated initializers you must implement when subclassing. See “Designated Initializers” for the complete list.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hinitTextCell:
Returns an NSCell object initialized with the specified string and set to have the cell’s default menu.
Parameters
- aString
The initial string to use for the cell.
Return Value
An initialized NSCell object, or nil if the cell could not be initialized.
Discussion
If no field editor (a shared NSText object) has been created for all NSCell objects, one is created.
This is one of four designated initializers you must implement when subclassing. See “Designated Initializers” for the complete list.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hintegerValue
Returns the receiver’s value as an NSInteger.
Return Value
The value of the cell interpreted as an NSInteger. If the receiver is not a text-type cell or the cell value is not scannable, returns 0.
Availability
- Available in OS X v10.5 and later.
See Also
Declared In
NSCell.hinteriorBackgroundStyle
Returns the interior background style for the receiver.
Return Value
Returns the interior background style for the receiver.
Discussion
The interior background style describes the surface drawn onto in drawInteriorWithFrame:inView:. This is often the same as the backgroundStyle, but a button that draws a bezel would have a different interiorBackgroundStyle.
This is both an override point and a useful method to call. In a custom button with a custom bezel you can override this method to describe that surface. A cell that has custom interior drawing might query this method to help pick an image that looks good on the cell. Calling this method gives you some independence from changes in framework art style.
Availability
- Available in OS X v10.5 and later.
Declared In
NSCell.hintValue
Returns the receiver’s value as an integer.
Return Value
The value of the cell interpreted as an integer. If the receiver is not a text-type cell or the cell value is not scannable, returns 0.
Discussion
On OS X v10.5 and later, you should use integerValue instead.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hisBezeled
Returns a Boolean value that indicates whether the receiver has a bezeled border.
Return Value
YES if the receiver has a bezeled border, otherwise NO.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hisBordered
Returns a Boolean value that indicates whether the receiver has a plain border.
Return Value
YES if the receiver has a plain border, otherwise NO.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hisContinuous
Returns a Boolean value that indicates whether the receiver’s cell sends its action message continuously to its target during mouse tracking.
Return Value
YES if the action message should be sent continuously, otherwise NO.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hisEditable
Returns a Boolean value that indicates whether the receiver is editable.
Return Value
YES if the receiver is editable, otherwise NO.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hisEnabled
Returns a Boolean value that indicates whether the receiver is enabled or disabled.
Return Value
YES if the receiver is enabled, otherwise NO.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hisHighlighted
Returns a Boolean value that indicates whether the receiver is highlighted.
Return Value
YES if the receiver has a highlight, otherwise NO.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hisOpaque
Returns a Boolean value that indicates whether the receiver is opaque (nontransparent).
Return Value
YES if the receiver is opaque, otherwise NO to indicate the receiver might have some transparency.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hisScrollable
Returns a Boolean value that indicates whether the receiver scrolls excess text past the cell’s bounds.
Return Value
YES if excess text scrolls past the cell's bounds, otherwise NO (text wrapping is enabled).
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hisSelectable
Returns a Boolean value that indicates whether the text of the receiver can be selected.
Return Value
YES if the receiver's text can be selected, otherwise NO.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hkeyEquivalent
Returns the key equivalent to clicking the cell.
Return Value
An empty string object.
Discussion
Subclasses can override this method to return a string with a valid character for the key equivalent.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hlineBreakMode
Returns the line break mode currently used when drawing text.
Return Value
The line break mode the receiver currently uses when drawing text. See NSLineBreakMode for supported values.
Availability
- Available in OS X v10.4 and later.
Declared In
NSCell.hmenu
Returns the receiver’s contextual menu.
Return Value
The receiver’s contextual menu, or nil if no menu is assigned.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hmenuForEvent:inRect:ofView:
Returns the menu associated with the receiver and related to the specified event and frame.
Parameters
- anEvent
The event used to find the menu.
- cellFrame
The cell's rectangle. This rectangle indicates the region containing the cursor.
- aView
The view that manages the receiver. This is usually the control object that owns the cell.
Return Value
The menu associated with the cell and event parameters, or nil if no menu is set.
Discussion
This method is usually invoked by the NSControl object (aView) managing the receiver. The default implementation simply invokes menu and returns nil if no menu has been set. Subclasses can override to customize the returned menu according to the event received and the area in which the mouse event occurs.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hmouseDownFlags
Returns the modifier flags for the last (left) mouse-down event.
Return Value
The modifier flags, or 0 if tracking has not yet occurred or no modifier keys accompanied the mouse-down event.
Availability
- Available in OS X v10.0 and later.
See Also
-
modifierFlags(NSEvent)
Declared In
NSCell.hnextState
Returns the receiver’s next state.
Return Value
The receiver’s next state (for possible values, see “NSCellStateValue”).
Discussion
If the receiver has three states, it cycles through them in this order: on, off, mixed, on, and so forth. If the receiver has two states, it toggles between them.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hobjectValue
Returns the receiver’s value as an Objective-C object
Return Value
The receiver's object value, or nil if a valid object has not been associated with the receiver.
Discussion
To be valid object value, the receiver must have a formatter capable of converting the object to and from its textual representation.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hperformClick:
Simulates a single mouse click on the receiver.
Parameters
- sender
The object to use as the sender of the event (if the receiver's control view is not valid). This object must be a subclass of
NSView.
Discussion
This method performs the receiver's action on its target. The receiver must be enabled to perform the action. If the receiver's control view is valid, that view is used as the sender; otherwise, the value in sender is used.
The receiver of this message must be a cell of type NSActionCell. This method raises an exception if the action message cannot be successfully sent.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hrefusesFirstResponder
Returns a Boolean value that indicates whether the receiver should not become the first responder.
Return Value
YES if the receiver should never become the first responder, otherwise NO if the receiver can become the first responder.
Discussion
To find out whether the receiver can become first responder at this time, use the method acceptsFirstResponder.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hrepresentedObject
Returns the object the receiver represents.
Return Value
The object represented by the receiver.
Discussion
Represented objects let you link a cell to an appropriate object. For example, you could have a pop-up list of color names, and the represented objects could be the appropriate NSColor objects.
Special Considerations
Note that if you copy an NSCell instance, the represented object in the copy is set to nil.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hresetCursorRect:inView:
Sets the receiver to show the I-beam cursor while it tracks the mouse.
Parameters
- cellFrame
The rectangle in which to display the I-beam cursor.
- controlView
The control that manages the cell.
Discussion
The receiver must be an enabled and selectable (or editable) text-type cell.
This method is invoked by resetCursorRects and in general you do not need to call this method unless you have a custom NSView that uses a cell.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hselectWithFrame:inView:editor:delegate:start:length:
Selects the specified text range in the cell's field editor.
Parameters
- aRect
The bounding rectangle of the cell.
- controlView
The control that manages the cell.
- textObj
The field editor to use for editing the cell.
- anObject
The object to use as a delegate for the field editor (
textObjparameter). This delegate object receives variousNSTextdelegation and notification methods during the course of editing the cell's contents.- selStart
The start of the text selection.
- selLength
The length of the text range.
Discussion
This method is similar to editWithFrame:inView:editor:delegate:event:, except that it can be invoked in any situation, not only on a mouse-down event. This method returns without doing anything if controlView, textObj, or the receiver is nil, or if the receiver has no font set for it.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hsendActionOn:
Sets the conditions on which the receiver sends action messages to its target.
Parameters
- mask
A bit mask containing the conditions for sending the action. The only conditions that are actually checked are associated with the
NSLeftMouseDownMask,NSLeftMouseUpMask,NSLeftMouseDraggedMask, andNSPeriodicMaskbits.
Return Value
A bit mask containing the previous settings. This bit mask uses the same values as specified in the mask parameter.
Discussion
You use this method during mouse tracking when the mouse button changes state, the mouse moves, or if the cell is marked to send its action continuously while tracking. Because of this, the only bits checked in mask are NSLeftMouseDownMask, NSLeftMouseUpMask, NSLeftMouseDraggedMask, and NSPeriodicMask, which are declared in the NSEvent class reference.
You can use the setContinuous: method to turn on the flag corresponding to NSPeriodicMask or NSLeftMouseDraggedMask, whichever is appropriate to the given subclass of NSCell.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsendsActionOnEndEditing
Returns a Boolean value that indicates whether the receiver’s NSControl object sends its action message whenever the user finishes editing the cell’s text.
Return Value
YES if the receiver's control sends its action message when editing is complete, otherwise NO.
Discussion
If this method returns YES, the receiver’s NSControl object sends its action message when the user does one of the following:
Presses the Return key
Presses the Tab key to move out of the field
Clicks another text field
If it returns NO, the cell’s NSControl object sends its action message only when the user presses the Return key.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetAction:
Sets the cell's action method to the specified selector.
Parameters
- aSelector
The new action-message selector to associate with the receiver's cell. Specify
NULLto prevent action messages from being sent to the receiver's target.
Discussion
The NSCell implementation of this method raises NSInternalInconsistencyException. Subclasses (such as NSActionCell) override this method to set the action method as part of the target/action implementation.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetAlignment:
Sets the alignment of text in the receiver.
Parameters
- mode
This value can be one of the following constants:
NSLeftTextAlignment,NSRightTextAlignment,NSCenterTextAlignment,NSJustifiedTextAlignment, orNSNaturalTextAlignment.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetAllowsEditingTextAttributes:
Sets whether the receiver allows the user to edit textual attributes of its contents.
Parameters
- flag
If
YES, the user can modify the font and other textual attributes of the cell's text. IfNO, the user cannot edit the text or import graphics, which effectively means the cell cannot support RTFD text.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hsetAllowsMixedState:
Sets whether the receiver supports three states or just two.
Parameters
- flag
If
YES, the receiver supports three states (on, off, and mixed); otherwise, ifNO, the receiver supports only two states (on and off).
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetAllowsUndo:
Sets whether the receiver assumes responsibility for undo operations within the cell.
Parameters
- allowsUndo
If
YES, the receiver handles undo operations; otherwise, ifNO, the application's custom undo manager handles undo operations.
Discussion
Subclasses invoke this method to indicate their preference for handling undo operations; otherwise, you should not need to call this method directly.
Availability
- Available in OS X v10.4 and later.
See Also
Declared In
NSCell.hsetAttributedStringValue:
Sets the value of the receiver’s cell using an attributed string.
Parameters
- attribStr
The value of the cell interpreted as an attributed string.
Discussion
If a formatter is set for the receiver, but the formatter does not understand the attributed string, it marks attribStr as an invalid object. If the receiver is not a text-type cell, it is converted to one before the value is set.
For OS X v10.3 and later: If you use a class that responds to the selector attributedStringValue for the object value of a cell, then the cell uses that method to fetch the string to draw rather than using stringValue.
The following example sets the text in a cell to 14 points, red, in the system font.
NSColor *txtColor = [NSColor redColor]; |
NSFont *txtFont = [NSFont boldSystemFontOfSize:14]; |
NSDictionary *txtDict = [NSDictionary dictionaryWithObjectsAndKeys: |
txtFont, NSFontAttributeName, txtColor, NSForegroundColorAttributeName, nil]; |
NSAttributedString *attrStr = [[[NSAttributedString alloc] |
initWithString:@"Hello!" attributes:txtDict] autorelease]; |
[[attrStrTextField cell] setAttributedStringValue:attrStr]; |
[attrStrTextField updateCell:[attrStrTextField cell]]; |
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetBackgroundStyle:
Sets the background style for the receiver.
Parameters
- style
The background style for the receiver.
Availability
- Available in OS X v10.5 and later.
Declared In
NSCell.hsetBaseWritingDirection:
Sets the initial writing direction used to determine the actual writing direction for text .
Parameters
- writingDirection
The initial writing direction the receiver uses to determine the actual writing direction for text. See
NSWritingDirectionfor possible values.
Discussion
If you know the base writing direction of the text you are rendering, you can use this method to specify that direction to the text system.
Availability
- Available in OS X v10.4 and later.
See Also
Declared In
NSCell.hsetBezeled:
Sets whether the receiver draws itself with a bezeled border.
Parameters
- flag
If
YES, the receiver uses a bezeled border.
Discussion
The setBezeled: and setBordered: methods are mutually exclusive (that is, a border can be only plain or bezeled). Invoking this method automatically removes any border that had already been set, regardless of the value in the flag parameter.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetBordered:
Sets whether the receiver draws itself outlined with a plain border.
Parameters
- flag
If
YES, the receiver uses a plain border.
Discussion
The setBezeled: and setBordered: methods are mutually exclusive (that is, a border can be only plain or bezeled). Invoking this method automatically removes any bezel that had already been set, regardless of the value in the flag parameter.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetCellAttribute:to:
Sets the value for the specified cell attribute.
Parameters
- aParameter
The cell attribute whose value you want to set. Attributes include the receiver's current state and whether it is disabled, editable, or highlighted.
- value
The new value for the attribute.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetContinuous:
Sets whether the receiver’s cell sends its action message continuously to its target during mouse tracking.
Parameters
- flag
If
YES, the action message should be sent continuously.
Discussion
In practice, the continuous setting of action messages has meaning only for NSActionCell and its subclasses, which implement the target/action mechanism. Some NSControl subclasses, notably NSMatrix, send a default action to a default target when a cell doesn’t provide a target or action.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetControlSize:
Sets the size of the receiver.
Parameters
- size
A value that specifies the size of the receiver (for possible values, see
“NSControlSize”).
Discussion
Changing the cell’s control size does not change the font of the cell. Use the systemFontSizeForControlSize: class method of NSFont to obtain the system font based on the new control size and set it.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetControlTint:
Sets the receiver’s control tint.
Parameters
- controlTint
An
Designated Initializersvalue that specifies the tint of the receiver.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetControlView:
Sets the receiver’s control view.
Parameters
- view
The view (normally an
NSControlobject) to associate with the cell.
Discussion
The control view represents the control currently being rendered by the cell.
Availability
- Available in OS X v10.4 and later.
See Also
Declared In
NSCell.hsetDoubleValue:
Sets the value of the receiver’s cell using a double-precision floating-point number.
Parameters
- aDouble
The value of the cell interpreted as a double-precision floating-point number.
Discussion
In its implementation, this method invokes the setObjectValue: method to set the actual value. This method does nothing if the receiver is not a text-type cell.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetEditable:
Sets whether the user can edit the receiver’s text.
Parameters
- flag
If
YES, the user is allowed to edit the receiver's text. If this value isYES, the text is also made selectable. If it isNO, the selectable attribute is restored to the value it was before the cell was last made editable.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetEnabled:
Sets whether the receiver is enabled or disabled.
Parameters
- flag
If
YESthe receiver is enabled; otherwise, ifNO, the receiver is disabled.
Discussion
The text of disabled cells is changed to gray. If a cell is disabled, it cannot be highlighted, does not support mouse tracking (and thus cannot participate in target/action functionality), and cannot be edited. However, you can still alter many attributes of a disabled cell programmatically. (The setState: method, for instance, still works.)
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetFloatValue:
Sets the value of the receiver’s cell using a single-precision floating-point number.
Parameters
- aFloat
The value of the cell interpreted as a single-precision floating-point number.
Discussion
In its implementation, this method invokes the setObjectValue: method to set the actual value. This method does nothing if the receiver is not a text-type cell.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetFocusRingType:
Sets the type of focus ring to be used.
Parameters
- focusRingType
Possible values are listed in
NSFocusRingType. To disable a view's focus ring, specifyNSFocusRingTypeNone.
Discussion
You should only disable a view from drawing its focus ring if you want to draw your own focus ring, or if there is not sufficient space to display a focus ring in the default location.
Availability
- Available in OS X v10.3 and later.
See Also
Declared In
NSCell.hsetFont:
Sets the font to use when the receiver displays text.
Parameters
- fontObj
The font to use.
Discussion
If the receiver is not a text-type cell, the method converts it to that type before setting the font.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetFormatter:
Sets the receiver's formatter object.
Parameters
- newFormatter
The formatter to use with the cell, or
nilif you do not want the cell to use a formatter.
Discussion
Cells use a formatter object to format the textual representation of their object value and to validate cell input and convert that input to an object value. If the new formatter cannot interpret the receiver’s current object value, that value is converted to a string object.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetHighlighted:
Sets whether the receiver has a highlighted appearance.
Parameters
- flag
If YES, the receiver has a highlight.
Discussion
By default, this method does nothing. The NSButtonCell class overrides this method to draw the button with the appearance specified by NSCellLightsByBackground, NSCellLightsByContents, or NSCellLightsByGray.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hsetImage:
Sets the image to be displayed by the receiver.
Parameters
- image
The image to display in the cell.
Discussion
If the receiver is not an image-type cell, the method converts it to that type of cell.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetImportsGraphics:
Sets whether the receiver can import images into its text.
Parameters
- flag
If
YES, the receiver can import images into its text and support RTFD text. IfNO, RTFD text is not supported.
Discussion
If flag is YES, the receiver is also set to allow editing of text attributes.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hsetIntegerValue:
Sets the value of the receiver using an NSInteger.
Parameters
- anInteger
The value of the cell interpreted as an
NSInteger.
Discussion
In its implementation, this method invokes the setObjectValue: method to set the actual value. This method does nothing if the receiver is not a text-type cell.
Availability
- Available in OS X v10.5 and later.
See Also
Declared In
NSCell.hsetIntValue:
Sets the value of the receiver using an integer.
Parameters
- anInt
The value of the cell interpreted as an integer.
Discussion
In its implementation, this method invokes the setObjectValue: method to set the actual value. This method does nothing if the receiver is not a text-type cell.
On OS X v10.5 and later, you should use setIntegerValue: instead.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetLineBreakMode:
Sets the line break mode to use when drawing text
Parameters
- mode
The line break mode the receiver currently uses when drawing text. See
NSLineBreakModefor supported values.
Discussion
The line break mode can also be modified by calling the setWraps: method.
Availability
- Available in OS X v10.4 and later.
See Also
Declared In
NSCell.hsetMenu:
Sets the contextual menu for the cell.
Parameters
- aMenu
A menu that has commands contextually related to the receiver. Specify
nilto clear the previous menu.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetNextState
Changes the state of the receiver to its next state.
Discussion
If the receiver has three states, it cycles through them in this order: on, off, mixed, on, and so forth. If the receiver has two states, it toggles between them.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hsetObjectValue:
Sets the receiver’s object value.
Parameters
- object
The new object value for the cell.
Discussion
To be valid object value, the receiver must have a formatter capable of converting the object to and from its textual representation.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetRefusesFirstResponder:
Sets whether the receiver should not become the first responder.
Parameters
- flag
If
YES, the receiver should never become the first responder; otherwise, it may become the first responder.
Discussion
If refusesFirstResponder returns NO and the cell is enabled, the method acceptsFirstResponder returns YES, allowing the cell to become first responder.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hsetRepresentedObject:
Sets the object represented by the receiver.
Parameters
- anObject
The object to associate with the receiver.
Discussion
You can use this method to link two objects together. For example, if the receiver's title was "Blue", you could associate an NSColor object whose color was set to blue.
Special Considerations
Note that if you copy an NSCell instance, the represented object in the copy is set to nil.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetScrollable:
Sets whether excess text in the receiver is scrolled past the cell’s bounds.
Parameters
- flag
If
YES, text can be scrolled past the cell's bounds; otherwise, ifNO, the text wrapping is enabled.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetSelectable:
Sets whether text in the receiver can be selected.
Parameters
- flag
If
YES, the receiver's text can be selected. If this value isNO, editability is also disabled; if it isYES, editability is not affected.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetSendsActionOnEndEditing:
Sets whether the receiver’s NSControl object sends its action message whenever the user finishes editing the cell’s text.
Parameters
- flag
If
YES, the receiver's control sends its action message when editing is complete; otherwise, ifNO, it sends the action message only when the user presses the Return key.
Discussion
If flag is YES, the receiver’s NSControl object sends its action message when the user does one of the following:
Presses the Return key
Presses the Tab key to move out of the field
Clicks another text field
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetShowsFirstResponder:
Sets whether the receiver draws some indication of its first responder status.
Parameters
- flag
If
YES, the receiver draws an indication of its first responder status, otherwise it does not.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetState:
Sets the receiver’s state to the specified value.
Parameters
- value
The possible state values are
NSOnState,NSOffState, andNSMixedState. If the cell supports only two states and you specifyNSMixedState, this method sets the state toNSOnState.
Discussion
The NSOffState state indicates the normal or unpressed state. The NSOnState state indicates the alternate or pressed state. The NSMixedState state indicates that the feature represented by the control is in effect somewhere.
Although using the enumerated constants is preferred, value can also be an integer. If the cell has two states, 0 is treated as NSOffState, and a nonzero value is treated as NSOnState. If the cell has three states, 0 is treated as NSOffState; a negative value, as NSMixedState; and a positive value, as NSOnState.
Note that the value state returns may not be the same value you passed into the value parameter.
To check whether the cell has three states (and uses the mixed state), invoke the allowsMixedState method.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetStringValue:
Sets the value of the receiver’s cell using an NSString object.
Parameters
- aString
The string value of the cell.
Discussion
In its implementation, this method invokes the setObjectValue: method to set the actual value. If no formatter is assigned to the receiver or if the formatter cannot “translate” aString to an underlying object, the receiver is flagged as having an invalid object. If the receiver is not a text-type cell, this method converts it to one before setting the object value.
For OS X v10.3 and later: If you use a class that responds to the selector attributedStringValue for the object value of a cell, the cell uses that method to fetch the string to draw rather than the stringValue method.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetTag:
Sets the tag of the receiver.
Parameters
- anInteger
The new tag for the cell.
Discussion
The NSCell implementation of this method raises NSInternalInconsistencyException. The NSActionCell implementation sets the receiver’s tag integer to anInteger.
Tags allow you to identify particular cells. Tag values are not used internally; they are only changed by external invocations of setTag:. You typically set tag values in Interface Builder and use them at runtime in your application. When you set the tag of a control with a single cell in Interface Builder, it sets the tags of both the control and the cell to the same value as a convenience.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetTarget:
Sets the target object to receive action messages.
Parameters
- anObject
The new target object to associate with the receiver's cell, or
nilto remove the current target.
Discussion
The NSCell implementation of this method raises NSInternalInconsistencyException. Subclasses (such as NSActionCell) override this method to set the target object as part of the target/action implementation.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetTitle:
Sets the title of the receiver.
Parameters
- aString
The new string value for the cell.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetTruncatesLastVisibleLine:
Sets whether the receiver truncates and adds the ellipsis character to the last visible line if the text doesn't fit into the cell bounds.
Parameters
- flag
If
YES, the receiver truncates the last line; ifNO, it does not truncate.
Discussion
The line break mode must be either NSLineBreakByWordWrapping or NSLineBreakByCharWrapping. Otherwise, this setting is ignored.
Availability
- Available in OS X v10.5 and later.
Declared In
NSCell.hsetType:
Sets the type of the cell, changing it to a text cell, image cell, or null cell.
Parameters
- aType
The new type of the cell (see
“NSCellType”for possible values).
Discussion
If the cell is already the same type as the one specified in the aType parameter, this method does nothing.
If aType is NSTextCellType, this method converts the receiver to a cell of that type, giving it a default title and setting the font to the system font at the default size. If aType is NSImageCellType, the cell type is not changed until you set a new non-nil image.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hsetUpFieldEditorAttributes:
Configures the textual and background attributes of the receiver's field editor.
Parameters
- textObj
The field editor to configure. .
Return Value
The configured field editor.
Discussion
If the receiver is disabled, this method sets the text color to dark gray; otherwise the method sets it to the default color. If the receiver has a bezeled border, this method sets the background to the default color for text backgrounds; otherwise, the method sets it to the color of the receiver’s NSControl object.
You should not use this method to substitute a new field editor. setUpFieldEditorAttributes: is intended to modify the attributes of the text object (that is, the field editor) passed into it and return that text object. If you want to substitute your own field editor, use the fieldEditor:forObject: method or the windowWillReturnFieldEditor:toObject: delegate method of NSWindow.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hsetUserInterfaceLayoutDirection:
Sets the layout direction of the user interface.
Parameters
- layoutDirection
The direction of the user interface layout. See
NSUserInterfaceLayoutDirectionfor possible values.
Discussion
This method specifies the general user interface layout flow directions. For NSCell subclasses that have multiple visual components in a single cell instance, this property should specify the directionality or flow of components. It affects, for example, the layout of an NSForm object's title and value fields, the position of a disclosure triangle, and so on.
Availability
- Available in OS X v10.6 and later.
See Also
Declared In
NSCell.hsetUsesSingleLineMode:
Sets whether the text cell restricts layout and rendering of its content to a single line.
Parameters
- flag
YESif layout and rendering should be restricted to a single line, otherwiseNO.
Discussion
If YES, the cell ignores the return value from wraps, interprets NSLineBreakByWordWrapping and NSLineBreakByCharWrapping returned by lineBreakMode as NSLineBreakByClipping, and configures the field editor to ignore key binding commands that insert paragraph and line separators.
The field editor bound to a single line cell filters paragraph and line separator insertion from user actions. Cells in the single line mode use the fixed baseline layout. The text baseline position is determined solely by the control size regardless of content font style or size.
Availability
- Available in OS X v10.6 and later.
See Also
Declared In
NSCell.hsetWraps:
Sets whether text in the receiver wraps when its length exceeds the frame of the cell.
Parameters
- flag
If
YES, the receiver wraps text and also makes the receiver non-scrollable; otherwise, ifNO, text is not wrapped.
Discussion
If the text of the receiver is an attributed string value you must explicitly set the paragraph style line break mode. Calling this method with the value YES is equivalent to calling the setLineBreakMode: method with the value NSLineBreakByWordWrapping.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hshowsFirstResponder
Returns a Boolean value that indicates whether the receiver should draw some indication of its first responder status.
Return Value
YES if the receiver should draw an indication of its first responder status, otherwise NO.
Discussion
The NSCell class itself does not draw a first-responder indicator. Subclasses may use the returned value to determine whether or not they should draw one, however.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hstartTrackingAt:inView:
Begins tracking mouse events within the receiver.
Parameters
- startPoint
The initial location of the cursor.
- controlView
The
NSControlobject managing the receiver.
Return Value
YES if the receiver is set to respond continuously or set to respond when the mouse is dragged, otherwise NO.
Discussion
The NSCell implementation of trackMouse:inRect:ofView:untilMouseUp: invokes this method when tracking begins. Subclasses can override this method to implement special mouse-tracking behavior at the beginning of mouse tracking—for example, displaying a special cursor.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hstate
Returns the receiver’s state.
Return Value
The receiver’s state (for possible values, see “NSCellStateValue”).
Discussion
Cells can have two or three states. If the receiver has two states, it returns either NSOffState (the normal or unpressed state) or NSOnState (the alternate or pressed state). If it has three, it may also return NSMixedState, indicating the feature is in effect somewhere.
To check whether the receiver uses the mixed state, use the method allowsMixedState.
Note that the value state returns may not be the same value you passed into setState:.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.hstopTracking:at:inView:mouseIsUp:
Stops tracking mouse events within the receiver.
Parameters
- lastPoint
Contains the previous position of the cursor.
- stopPoint
The current location of the cursor.
- controlView
The
NSControlobject managing the receiver.- flag
If
YES, this method was invoked because the user released the mouse button; otherwise, ifNO, the cursor left the designated tracking rectangle.
Discussion
The default NSCell implementation of trackMouse:inRect:ofView:untilMouseUp: invokes this method when the cursor has left the bounds of the receiver or the mouse button goes up. The default NSCell implementation of this method does nothing. Subclasses often override this method to provide customized tracking behavior. The following example increments the state of a tristate cell when the mouse button is clicked:
- (void)stopTracking:(NSPoint)lastPoint at:(NSPoint)stopPoint |
inView:(NSView *)controlView mouseIsUp:(BOOL)flag |
{ |
if (flag == YES) { |
[self setTriState:([self triState]+1)]; |
} |
} |
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.hstringValue
Returns the value of the receiver’s cell as an NSString object.
Return Value
The string value of the cell. This value may be an interpreted version of the cell's actual value. Interpretations are performed by the cell's formatter.
Discussion
If no formatter exists and the cell's value is an NSString object, this method returns the value as a plain, attributed, or localized formatted string. If the value is not an NSString object or cannot be converted to one, this method returns an empty string.
For OS X v10.3 and later: If you use a class that responds to the selector attributedStringValue for the object value of a cell, the cell uses that method to fetch the string to draw rather than the stringValue method.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.htag
Returns the tag identifying the receiver.
Return Value
The tag value. The NSCell implementation of this method returns –1.
Discussion
Tags allow you to identify particular cells. Tag values are not used internally; they are only changed by external invocations of setTag:. You typically set tag values in Interface Builder and use them at runtime in your application. When you set the tag of a control with a single cell in Interface Builder, it sets the tags of both the control and the cell to the same value as a convenience.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.htakeDoubleValueFrom:
Sets the value of the receiver’s cell to a double-precision floating-point value obtained from the specified object.
Parameters
- sender
The object from which to take the value. This object must respond to the
doubleValuemessage.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.htakeFloatValueFrom:
Sets the value of the receiver’s cell to a single-precision floating-point value obtained from the specified object.
Parameters
- sender
The object from which to take the value. This object must respond to the
floatValuemessage.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.htakeIntegerValueFrom:
Sets the value of the receiver’s cell to an integer value obtained from the specified object.
Parameters
- sender
The object from which to take the value. This object must respond to the
integerValuemessage.
Availability
- Available in OS X v10.5 and later.
See Also
Declared In
NSCell.htakeIntValueFrom:
Sets the value of the receiver’s cell to an integer value obtained from the specified object.
Parameters
- sender
The object from which to take the value. This object must respond to the
intValuemessage.
Discussion
On OS X v10.5 and later you should use takeIntegerValueFrom: instead.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.htakeObjectValueFrom:
Sets the value of the receiver’s cell to the object value obtained from the specified object.
Parameters
- sender
The object from which to take the value. This object must respond to the
objectValuemessage.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.htakeStringValueFrom:
Sets the value of the receiver’s cell to the string value obtained from the specified object.
Parameters
- sender
The object from which to take the value. This object must respond to the
stringValuemessage.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.htarget
Returns the target object of the receiver.
Return Value
The target object that receives action messages from the cell. The NSCell implementation of this method returns nil.
Discussion
Subclasses (such as NSActionCell) override this method to return the target object as part of the target/action implementation.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.htitle
Returns the receiver’s title.
Return Value
The cell's string value.
Discussion
Subclasses (such as NSButtonCell) may override this method to return a different value.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.htitleRectForBounds:
Returns the rectangle in which the receiver draws its title text.
Parameters
- theRect
The bounding rectangle of the receiver.
Return Value
The rectangle in which the receiver draws its title text.
Discussion
If the receiver is a text-type cell, this method resizes the drawing rectangle for the title (theRect) inward by a small offset to accommodate the cell border. If the receiver is not a text-type cell, the method does nothing.
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.htrackMouse:inRect:ofView:untilMouseUp:
Initiates the mouse tracking behavior in a cell.
Parameters
- theEvent
The event that caused the mouse tracking to occur.
- cellFrame
The receiver's frame rectangle.
- controlView
The view containing the receiver. This is usually an
NSControlobject.- untilMouseUp
If
YES, mouse tracking continues until the user releases the mouse button. IfNO, tracking continues until the cursor leaves the tracking rectangle, specified by the cellFrame parameter, regardless of the mouse button state. See the discussion for more information.
Return Value
YES if the mouse tracking conditions are met, otherwise NO.
Discussion
This method is generally not overridden because the default implementation invokes other NSCell methods that can be overridden to handle specific events in a dragging session. This method’s return value depends on the untilMouseUp flag. If untilMouseUp is set to YES, this method returns YES if the mouse button goes up while the cursor is anywhere; NO, otherwise. If untilMouseUp is set to NO, this method returns YES if the mouse button goes up while the cursor is within cellFrame; NO, otherwise.
This method first invokes startTrackingAt:inView:. If that method returns YES, then as mouse-dragged events are intercepted, continueTracking:at:inView: is invoked until either the method returns NO or the mouse is released. Finally, stopTracking:at:inView:mouseIsUp: is invoked if the mouse is released. If untilMouseUp is YES, it’s invoked when the mouse button goes up while the cursor is anywhere. If untilMouseUp is NO, it’s invoked when the mouse button goes up while the cursor is within cellFrame. You usually override one or more of these methods to respond to specific mouse events.
Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.htruncatesLastVisibleLine
Returns a Boolean value indicating whether the receiver truncates and adds the ellipsis character to the last visible line if the text doesn't fit into the cell bounds.
Return Value
YES if the receiver truncates the last line; otherwise NO.
Discussion
The line break mode must be either NSLineBreakByWordWrapping or NSLineBreakByCharWrapping. Otherwise, this setting is ignored.
Availability
- Available in OS X v10.5 and later.
Declared In
NSCell.htype
Returns the type of the receiver
Return Value
The type of the cell (see “NSCellType” for possible values).
Availability
- Available in OS X v10.0 and later.
See Also
Declared In
NSCell.huserInterfaceLayoutDirection
Returns the layout direction of the user interface.
Return Value
The direction of the user interface layout. See NSUserInterfaceLayoutDirection for possible values.
Availability
- Available in OS X v10.6 and later.
See Also
Declared In
NSCell.husesSingleLineMode
Returns whether the text cell restricts layout and rendering of its content to a single line.
Return Value
YES if layout and rendering is restricted to a single line, otherwise NO.
Availability
- Available in OS X v10.6 and later.
See Also
Declared In
NSCell.hwantsNotificationForMarkedText
Returns a Boolean value that indicates whether the field editor initiated by the receiver should post text change notifications.
Return Value
YES if the field editor initiated by the receiver should post text change notifications (NSTextDidChangeNotification) while editing marked text; otherwise, they are delayed until the marked text confirmation.
Discussion
NSCell's implementation returns NO.
Availability
- Available in OS X v10.5 and later.
Declared In
NSCell.hConstants
NSCellType
These constants specify how a cell represents its data (as text or as an image). These constants are used by setType: and type.
enum {
NSNullCellType = 0,
NSTextCellType = 1,
NSImageCellType = 2
};
typedef NSUInteger NSCellType;
Constants
NSNullCellTypeCell displays nothing.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSTextCellTypeCell displays text.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSImageCellTypeCell displays images.
Available in OS X v10.0 and later.
Declared in
NSCell.h.
NSCellAttribute
These constants specify how a button behaves when pressed and how it displays its state. These constants are used by the NSButton and NSButtonCell classes
enum {
NSCellDisabled = 0,
NSCellState = 1,
NSPushInCell = 2,
NSCellEditable = 3,
NSChangeGrayCell = 4,
NSCellHighlighted = 5,
NSCellLightsByContents = 6,
NSCellLightsByGray = 7,
NSChangeBackgroundCell = 8,
NSCellLightsByBackground = 9,
NSCellIsBordered = 10,
NSCellHasOverlappingImage = 11,
NSCellHasImageHorizontal = 12,
NSCellHasImageOnLeftOrBottom = 13,
NSCellChangesContents = 14,
NSCellIsInsetButton = 15,
NSCellAllowsMixedState = 16
};
typedef NSUInteger NSCellAttribute;
Constants
NSCellAllowsMixedStateLets the cell’s state be
NSMixedState, as well asNSOffStateandNSOnState.Available in OS X v10.0 and later.
Declared in
NSCell.h.NSChangeBackgroundCellIf the cell’s state is
NSMixedStateorNSOnState, changes the cell’s background color from gray to white.Available in OS X v10.0 and later.
Declared in
NSCell.h.NSCellChangesContentsIf the cell’s state is
NSMixedStateorNSOnState, displays the cell’s alternate image.Available in OS X v10.0 and later.
Declared in
NSCell.h.NSChangeGrayCellIf the cell’s state is
NSMixedStateorNSOnState, displays the cell’s image as darkened.Available in OS X v10.0 and later.
Declared in
NSCell.h.NSCellDisabledDoes not let the user manipulate the cell.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSCellEditableLets the user edit the cell’s contents.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSCellHasImageHorizontalControls the position of the cell’s image: places the image on the right of any text in the cell.
Together,
NSCellHasImageOnLeftOrBottom,NSCellHasImageHorizontal, andNSCellHasOverlappingImagecontrol the position of the cell’s image and text. To place the image above, set none of them. To place the image below, setNSCellHasImageOnLeftOrBottom. To place the image to the right, setNSCellHasImageHorizontal. To place the image to the left, setNSCellHasImageHorizontalandNSCellHasImageOnLeftOrBottom. To place the image directly over, setNSCellHasOverlappingImage.Available in OS X v10.0 and later.
Declared in
NSCell.h.NSCellHasImageOnLeftOrBottomControls the position of the cell’s image: places the image on the left of or below any text in the cell.
See
NSCellHasImageHorizontalfor more details.Available in OS X v10.0 and later.
Declared in
NSCell.h.NSCellHasOverlappingImageControls the position of the cell’s image: places the image over any text in the cell.
See
NSCellHasImageHorizontalfor more details.Available in OS X v10.0 and later.
Declared in
NSCell.h.NSCellHighlightedDraws the cell with a highlighted appearance. (Deprecated. Use
setHighlighted:instead.)Available in OS X v10.0 and later.
Declared in
NSCell.h.NSCellIsBorderedDraws a border around the cell.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSCellIsInsetButtonInsets the cell’s contents from the border.
By default, the cell’s contents are inset by 2 points. This constant is ignored if the cell has no border.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSCellLightsByBackgroundIf the cell is pushed in, changes the cell’s background color from gray to white.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSCellLightsByContentsIf the cell is pushed in, displays the cell’s alternate image.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSCellLightsByGrayIf the cell is pushed in, displays the cell’s image as darkened.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSPushInCellDetermines whether the cell’s image and text appear to be shifted down and to the right.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSCellStateThe cell’s state.
The cell’s state can be
NSMixedState,NSOffState, orNSOnState.Available in OS X v10.0 and later.
Declared in
NSCell.h.
NSCellImagePosition
These constants specify the position of a button’s image relative to its title. These constants are used by the setImagePosition: and imagePosition methods of NSButton and NSButtonCell.
enum {
NSNoImage = 0,
NSImageOnly = 1,
NSImageLeft = 2,
NSImageRight = 3,
NSImageBelow = 4,
NSImageAbove = 5,
NSImageOverlaps = 6
};
typedef NSUInteger NSCellImagePosition;
Constants
NSNoImageThe cell doesn’t display an image.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSImageOnlyThe cell displays an image, but not a title.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSImageLeftThe image is to the left of the title.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSImageRightThe image is to the right of the title.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSImageBelowThe image is below the title.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSImageAboveThe image is above the title.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSImageOverlapsThe image overlaps the title.
Available in OS X v10.0 and later.
Declared in
NSCell.h.
NSImageScaling
These constants specify a cell’s image scaling behavior.
enum {
NSImageScaleProportionallyDown = 0,
NSImageScaleAxesIndependently,
NSImageScaleNone,
NSImageScaleProportionallyUpOrDown
};
typedef NSUInteger NSImageScaling;
Constants
NSImageScaleProportionallyDownIf it is too large for the destination, scale the image down while preserving the aspect ratio.
Available in OS X v10.5 and later.
Declared in
NSCell.h.NSImageScaleAxesIndependentlyScale each dimension to exactly fit destination.
This setting does not preserve the aspect ratio of the image.
Available in OS X v10.5 and later.
Declared in
NSCell.h.NSImageScaleNoneDo not scale the image.
Available in OS X v10.5 and later.
Declared in
NSCell.h.NSImageScaleProportionallyUpOrDownScale the image to its maximum possible dimensions while both staying within the destination area and preserving its aspect ratio.
Available in OS X v10.5 and later.
Declared in
NSCell.h.
NSCellStateValue
These constants specify a cell’s state and are used mostly for buttons. These constants are described in “Cell States” of Control and Cell Programming Topics.
enum {
NSMixedState = -1,
NSOffState = 0,
NSOnState = 1
};
typedef NSUInteger NSCellStateValue;
Constants
NSMixedStateThe corresponding feature is in effect somewhere.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSOffStateThe corresponding feature is in effect nowhere.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSOnStateThe corresponding feature is in effect everywhere.
Available in OS X v10.0 and later.
Declared in
NSCell.h.
State Masks
These constants specify what happens when a button is pressed or is displaying its alternate state. These contents are used by the highlightsBy and showsStateBy methods of NSButtonCell.
enum {
NSNoCellMask = 0,
NSContentsCellMask = 1,
NSPushInCellMask = 2,
NSChangeGrayCellMask = 4,
NSChangeBackgroundCellMask = 8
};
Constants
NSNoCellMaskThe button cell doesn’t change.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSPushInCellMaskThe button cell “pushes in” if it has a border.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSContentsCellMaskThe button cell displays its alternate icon and/or title.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSChangeGrayCellMaskThe button cell swaps the “control color” (the
controlColormethod ofNSColor) and white pixels on its background and icon.Available in OS X v10.0 and later.
Declared in
NSCell.h.NSChangeBackgroundCellMaskSame as
NSChangeGrayCellMask, but only background pixels are changed.Available in OS X v10.0 and later.
Declared in
NSCell.h.
NSControlTint
These constants specify a cell’s tint. These constants are used by controlTint and setControlTint:.
enum {
NSDefaultControlTint = 0,
NSBlueControlTint = 1,
NSGraphiteControlTint = 6,
NSClearControlTint = 7
};
typedef NSUInteger NSControlTint;
Constants
NSDefaultControlTintThe current default tint setting
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSClearControlTintClear control tint
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSBlueControlTintAqua control tint
Available in OS X v10.3 and later.
Declared in
NSCell.h.NSGraphiteControlTintGraphite control tint
Available in OS X v10.3 and later.
Declared in
NSCell.h.
NSControlSize
These constants specify a cell’s size. These constants are used by controlSize and setControlSize:.
enum {
NSRegularControlSize,
NSSmallControlSize,
NSMiniControlSize
};
typedef NSUInteger NSControlSize;
Constants
NSRegularControlSizeThe control is sized as regular.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSSmallControlSizeThe control has a smaller size.
This constant is for controls that cannot be resized in one direction, such as push buttons, radio buttons, checkboxes, sliders, scroll bars, pop-up buttons, tabs, and progress indicators. You should use a small system font with a small control.
Available in OS X v10.0 and later.
Declared in
NSCell.h.NSMiniControlSizeThe control has a smaller size than
NSSmallControlSize.Available in OS X v10.3 and later.
Declared in
NSCell.h.
Hit Testing
These constants are used by hitTestForEvent:inRect:ofView: to determine the effect of an event.
enum {
NSCellHitNone = 0,
NSCellHitContentArea = 1 << 0,
NSCellHitEditableTextArea = 1 << 1,
NSCellHitTrackableArea = 1 << 2,
};
Constants
NSCellHitNoneAn empty area, or did not hit in the cell.
Available in OS X v10.5 and later.
Declared in
NSCell.h.NSCellHitContentAreaA content area in the cell.
Available in OS X v10.5 and later.
Declared in
NSCell.h.NSCellHitEditableTextAreaAn editable text area of the cell.
Available in OS X v10.5 and later.
Declared in
NSCell.h.NSCellHitTrackableAreaA trackable area in the cell.
Available in OS X v10.5 and later.
Declared in
NSCell.h.
Declared In
NSCell.hNSBackgroundStyle
Background styles used with backgroundStyle, setBackgroundStyle:, and interiorBackgroundStyle.
enum {
NSBackgroundStyleLight = 0,
NSBackgroundStyleDark,
NSBackgroundStyleRaised,
NSBackgroundStyleLowered
};
typedef NSUInteger NSBackgroundStyle;
Constants
NSBackgroundStyleLightThe background is a light color.
Dark content contrasts well with this background.
Available in OS X v10.5 and later.
Declared in
NSCell.h.NSBackgroundStyleDarkThe background is a dark color.
Light content contrasts well with this background.
Available in OS X v10.5 and later.
Declared in
NSCell.h.NSBackgroundStyleRaisedThe background is intended to appear higher than the content drawn on it.
Content might need to be inset.
Available in OS X v10.5 and later.
Declared in
NSCell.h.NSBackgroundStyleLoweredThe background is intended to appear lower than the content drawn on it.
Content might need to be embossed.
Available in OS X v10.5 and later.
Declared in
NSCell.h.
Deprecated Scaling Constants
These are deprecated scaling constants. (Deprecated. Use “NSImageScaling” constants instead.)
enum {
NSScaleProportionally = 0,
NSScaleToFit,
NSScaleNone
};
Constants
NSScaleProportionallyUse
NSImageScaleProportionallyDown.Available in OS X v10.0 and later.
Deprecated in OS X v10.6.
Declared in
NSCell.h.NSScaleToFitUse
NSImageScaleAxesIndependently.Available in OS X v10.0 and later.
Deprecated in OS X v10.6.
Declared in
NSCell.h.NSScaleNoneUse
NSImageScaleNone.Available in OS X v10.0 and later.
Deprecated in OS X v10.6.
Declared in
NSCell.h.
Data Entry Types
These constants specify how a cell formats numeric data.
enum {
NSAnyType = 0,
NSIntType = 1,
NSPositiveIntType = 2,
NSFloatType = 3,
NSPositiveFloatType = 4,
NSDoubleType = 6,
NSPositiveDoubleType = 7
};
Constants
NSIntTypeMust be between
INT_MINandINT_MAX.Deprecated in OS X v10.4 and later.
Declared in
NSCell.h.NSPositiveIntTypeMust be between 1 and
INT_MAX.Deprecated in OS X v10.4 and later.
Declared in
NSCell.h.NSFloatTypeMust be between
–FLT_MAXandFLT_MAX.Deprecated in OS X v10.4 and later.
Declared in
NSCell.h.NSPositiveFloatTypeMust be between
FLT_MINandFLT_MAX.Deprecated in OS X v10.4 and later.
Declared in
NSCell.h.NSDoubleTypeMust be between
–FLT_MAXandFLT_MAX.Deprecated in OS X v10.4 and later.
Declared in
NSCell.h.NSPositiveDoubleTypeMust be between
FLT_MINandFLT_MAX.Deprecated in OS X v10.4 and later.
Declared in
NSCell.h.NSAnyTypeAny value is allowed.
Deprecated in OS X v10.4 and later.
Declared in
NSCell.h.
Discussion
These constants are used by setEntryType: and entryType.
Declared In
NSCell.hNotifications
NSControlTintDidChangeNotification
NSApp. This notification does not contain a userInfo dictionary.Availability
- Available in OS X v10.0 and later.
Declared In
NSCell.h© 2011 Apple Inc. All Rights Reserved. (Last updated: 2011-07-01)