Mac Developer Library

Developer

AppKit Framework Reference NSComboBox Class Reference

Options
Deployment Target:

On This Page
Language:

NSComboBox

An NSComboBox is a kind of NSControl that allows you to either enter text directly (as you would with an NSTextField) or click the attached arrow at the right of the combo box and select from a displayed (“pop-up”) list of items. More...

Import Statement


import AppKit @import AppKit;

Availability


Available in OS X v10.0 and later.
  • Returns a Boolean value indicating whether the receiver will display a vertical scroller.

    Declaration

    Swift

    var hasVerticalScroller: Bool

    Objective-C

    @property BOOL hasVerticalScroller

    Return Value

    YEStrue if the receiver will display a vertical scroller; otherwise NOfalse.

    Discussion

    Note that the scroller will be displayed even if the pop-up list contains fewer items than will fit in the area specified for display.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Returns the horizontal and vertical spacing between cells in the receiver’s pop-up list.

    Declaration

    Swift

    var intercellSpacing: NSSize

    Objective-C

    @property NSSize intercellSpacing

    Return Value

    The space between cells in the pop-up list. The default spacing is (3.0, 2.0).

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • isButtonBordered isButtonBordered Available in OS X v10.3 through OS X v10.9

    Returns whether the combo box button is set to display a border.

    Declaration

    Objective-C

    - (BOOL)isButtonBordered

    Return Value

    YEStrue if the button has a border; otherwise NOfalse.

    Import Statement

    Availability

    Available in OS X v10.3 through OS X v10.9.

  • Returns the height of each item in the receiver’s pop-up list.

    Declaration

    Swift

    var itemHeight: CGFloat

    Objective-C

    @property CGFloat itemHeight

    Return Value

    The height of items in the pop-up list. The default item height is 16.0.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Returns the maximum number of items visible in the pop-up list.

    Declaration

    Swift

    var numberOfVisibleItems: Int

    Objective-C

    @property NSInteger numberOfVisibleItems

    Return Value

    The maximum number of items visible at any one time in the pop-up list.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Determines whether the button in the combo box is displayed with a border.

    Declaration

    Swift

    var buttonBordered: Bool

    Objective-C

    @property(getter=isButtonBordered) BOOL buttonBordered

    Parameters

    flag

    YEStrue to display a border; NOfalse to display the button without a border. For example, it is often useful when using a combo box in an NSTableView to display the button without the border.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.3 and later.

  • Determines whether the receiver displays a vertical scroller.

    Declaration

    Swift

    var hasVerticalScroller: Bool

    Objective-C

    @property BOOL hasVerticalScroller

    Parameters

    flag

    YEStrue to display a vertical scroller; NOfalse otherwise. By default, flag is YEStrue.

    Discussion

    If flag is NOfalse and the combo box has more list items (either in its internal item list or from its data source) than are allowed by numberOfVisibleItems, only a subset are displayed. The NSComboBox class' scroll... methods can be used to position this subset within the pop-up list.

    Note that if flag is YEStrue, a scroller will be displayed even if the combo box has fewer list items than are allowed by numberOfVisibleItems.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Sets the spacing between pop-up list items.

    Declaration

    Swift

    var intercellSpacing: NSSize

    Objective-C

    @property NSSize intercellSpacing

    Parameters

    aSize

    The new width and height between pop-up list items. The default intercell spacing is (3.0, 2.0).

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Sets the height for items.

    Declaration

    Swift

    var itemHeight: CGFloat

    Objective-C

    @property CGFloat itemHeight

    Parameters

    itemHeight

    The new height for items in the pop-up list.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Sets the maximum number of items that are visible in the receiver’s pop-up list.

    Declaration

    Swift

    var numberOfVisibleItems: Int

    Objective-C

    @property NSInteger numberOfVisibleItems

    Parameters

    visibleItems

    The maximum number of items that are visible at one time in the pop-up list.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Returns the object that provides the data displayed in the receiver’s pop-up list.

    Declaration

    Swift

    unowned(unsafe) var dataSource: NSComboBoxDataSource?

    Objective-C

    @property(assign) id<NSComboBoxDataSource> dataSource

    Return Value

    The data source for the combo box's pop-up list.

    Discussion

    This method logs a warning if usesDataSource returns NOfalse. See the class description and the NSComboBoxDataSource informal protocol specification for more information on combo box data source objects.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Sets the receiver’s data source to aSource.

    Declaration

    Swift

    unowned(unsafe) var dataSource: NSComboBoxDataSource?

    Objective-C

    @property(assign) id<NSComboBoxDataSource> dataSource

    Parameters

    aSource

    The new data source for the receiver. The data source should implement the appropriate methods of the NSComboBoxDataSource informal protocol.

    This method logs a warning if aSource doesn’t respond to either numberOfItemsInComboBox: or comboBox:objectValueForItemAtIndex:.

    Discussion

    This method doesn’t automatically set usesDataSource to NOfalse and in fact logs a warning if usesDataSource returns NOfalse.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Sets whether the receiver uses an external data source to populate the receiver’s pop-up list.

    Declaration

    Swift

    var usesDataSource: Bool

    Objective-C

    @property BOOL usesDataSource

    Parameters

    flag

    YEStrue if the receiver uses an external data source (specified by setDataSource:); otherwise NOfalse.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Returns a Boolean value indicating whether the receiver uses an external data source to populate its pop-up list.

    Declaration

    Swift

    var usesDataSource: Bool

    Objective-C

    @property BOOL usesDataSource

    Return Value

    YEStrue if the receiver uses an external data source to populate the receiver’s pop-up list, NOfalse if it uses an internal item list.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

    See Also

    – dataSource

  • Adds multiple objects to the end of the receiver’s internal item list.

    Declaration

    Swift

    func addItemsWithObjectValues(_ objects: [AnyObject])

    Objective-C

    - (void)addItemsWithObjectValues:(NSArray *)objects

    Parameters

    objects

    An array of the objects to add to the internal item list.

    Discussion

    This method logs a warning if usesDataSource returns YEStrue.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Adds an object to the end of the receiver’s internal item list.

    Declaration

    Swift

    func addItemWithObjectValue(_ anObject: AnyObject)

    Objective-C

    - (void)addItemWithObjectValue:(id)anObject

    Parameters

    anObject

    The object to add to the internal item list.

    Discussion

    This method logs a warning if usesDataSource returns YEStrue.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Inserts an object at the specified location in the receiver’s internal item list.

    Declaration

    Swift

    func insertItemWithObjectValue(_ anObject: AnyObject, atIndex index: Int)

    Objective-C

    - (void)insertItemWithObjectValue:(id)anObject atIndex:(NSInteger)index

    Parameters

    anObject

    The object to add to the internal item list.

    index

    The index in the list at which to add the new object. The previous item at index—along with all following items—is shifted down one slot to make room

    Discussion

    This method logs a warning if usesDataSource returns YEStrue.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Returns as an array the receiver’s internal item list.

    Declaration

    Swift

    var objectValues: [AnyObject] { get }

    Objective-C

    @property(readonly, copy) NSArray *objectValues

    Return Value

    The array containing the objects in the receiver's internal item list.

    Discussion

    This method logs a warning if usesDataSource returns YEStrue.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Removes all items from the receiver’s internal item list.

    Declaration

    Swift

    func removeAllItems()

    Objective-C

    - (void)removeAllItems

    Discussion

    This method logs a warning if usesDataSource returns YEStrue.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Removes the object at the specified location from the receiver’s internal item list.

    Declaration

    Swift

    func removeItemAtIndex(_ index: Int)

    Objective-C

    - (void)removeItemAtIndex:(NSInteger)index

    Parameters

    index

    The index of the object to remove. All items beyond index are moved up one slot to fill the gap.

    Discussion

    The removed object receives a release message. This method raises an NSRangeException if index is beyond the end of the list and logs a warning if usesDataSource returns YEStrue.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Removes all occurrences of the given object from the receiver’s internal item list.

    Declaration

    Swift

    func removeItemWithObjectValue(_ anObject: AnyObject)

    Objective-C

    - (void)removeItemWithObjectValue:(id)anObject

    Parameters

    anObject

    The object to remove from the internal item list. Objects are considered equal if they have the same id or if isEqual: returns YEStrue.

    Discussion

    This method logs a warning if usesDataSource returns YEStrue.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Returns the total number of items in the pop-up list.

    Declaration

    Swift

    var numberOfItems: Int { get }

    Objective-C

    @property(readonly) NSInteger numberOfItems

    Return Value

    The number of items in the list.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

    See Also

    – numberOfVisibleItems
    – numberOfItemsInComboBox: (NSComboBoxDataSource protocol)

  • Searches the receiver’s internal item list for the specified object and returns the lowest matching index.

    Declaration

    Swift

    func indexOfItemWithObjectValue(_ anObject: AnyObject) -> Int

    Objective-C

    - (NSInteger)indexOfItemWithObjectValue:(id)anObject

    Parameters

    anObject

    The object for which to return the index.

    Return Value

    The lowest index in the internal item list whose corresponding value is equal to that of the specified object. Objects are considered equal if they have the same id or if isEqual: returns YEStrue.

    If none of the objects in the receiver’s internal item list are equal to anObject, indexOfItemWithObjectValue: returns NSNotFound.

    Discussion

    This method logs a warning if usesDataSource returns YEStrue.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Returns the object located at the given index within the receiver’s internal item list.

    Declaration

    Swift

    func itemObjectValueAtIndex(_ index: Int) -> AnyObject

    Objective-C

    - (id)itemObjectValueAtIndex:(NSInteger)index

    Parameters

    index

    The index of the object to retrieve. If index is beyond the end of the list, an NSRangeException is raised.

    Return Value

    The object located at the specified index in the internal item list.

    Discussion

    This method logs a warning if usesDataSource returns YEStrue.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Informs the receiver that the number of items in its data source has changed.

    Declaration

    Swift

    func noteNumberOfItemsChanged()

    Objective-C

    - (void)noteNumberOfItemsChanged

    Discussion

    This method allows the receiver to update the scrollers in its displayed pop-up list without actually reloading data into the receiver. It is particularly useful for a data source that continually receives data in the background over a period of time, in which case the NSComboBox can remain responsive to the user while the data is received.

    See the NSComboBoxDataSource informal protocol specification for information on the messages an NSComboBox sends to its data source.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

    See Also

    – reloadData

  • Marks the receiver as needing redisplay, so that it will reload the data for visible pop-up items and draw the new values.

    Declaration

    Swift

    func reloadData()

    Objective-C

    - (void)reloadData

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Scrolls the receiver’s pop-up list vertically so that the item at the specified index is as close to the top as possible.

    Declaration

    Swift

    func scrollItemAtIndexToTop(_ index: Int)

    Objective-C

    - (void)scrollItemAtIndexToTop:(NSInteger)index

    Parameters

    index

    The index of the item to scroll to the top.

    Discussion

    The pop-up list need not be displayed at the time this method is invoked.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Scrolls the receiver’s pop-up list vertically so that the item at the specified index is visible.

    Declaration

    Swift

    func scrollItemAtIndexToVisible(_ index: Int)

    Objective-C

    - (void)scrollItemAtIndexToVisible:(NSInteger)index

    Parameters

    index

    The index of the item to make visible.

    Discussion

    The pop-up list need not be displayed at the time this method is invoked.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Deselects the pop-up list item at the specified index if it’s selected.

    Declaration

    Swift

    func deselectItemAtIndex(_ index: Int)

    Objective-C

    - (void)deselectItemAtIndex:(NSInteger)index

    Parameters

    index

    The index of the item to deselect.

    Discussion

    If the selection does in fact change, this method posts an NSComboBoxSelectionDidChangeNotification to the default notification center.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Returns the index of the last item selected from the pop-up list.

    Declaration

    Swift

    var indexOfSelectedItem: Int { get }

    Objective-C

    @property(readonly) NSInteger indexOfSelectedItem

    Return Value

    The index of the last item selected from the receiver's pop-up list or -1 if no item is selected.

    Discussion

    Note that nothing is initially selected in a newly initialized combo box.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Returns the object corresponding to the last item selected from the pop-up list.

    Declaration

    Swift

    var objectValueOfSelectedItem: AnyObject? { get }

    Objective-C

    @property(readonly, strong) id objectValueOfSelectedItem

    Return Value

    The object in the receiver's internal item list corresponding to the last item selected from the pop-up list, or nil if no item is selected.

    Discussion

    Note that nothing is initially selected in a newly initialized combo box. This method logs a warning if usesDataSource returns YEStrue.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

    See Also

    – indexOfSelectedItem
    – comboBox:objectValueForItemAtIndex: (NSComboBoxDataSource protocol)

  • Selects the pop-up list row at the given index.

    Declaration

    Swift

    func selectItemAtIndex(_ index: Int)

    Objective-C

    - (void)selectItemAtIndex:(NSInteger)index

    Parameters

    index

    The index of the item to select in the pop-up list.

    Discussion

    Posts an NSComboBoxSelectionDidChangeNotification to the default notification center if the selection does in fact change. Note that this method does not alter the contents of the combo box’s text field—see Setting the Combo Box’s Value in Combo Box Programming Topics for more information.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

    See Also

    – setObjectValue: (NSControl)

  • Selects the first pop-up list item that corresponds to the given object.

    Declaration

    Swift

    func selectItemWithObjectValue(_ anObject: AnyObject?)

    Objective-C

    - (void)selectItemWithObjectValue:(id)anObject

    Parameters

    anObject

    The object to select in the pop-up list. Objects are considered equal if they have the same id or if isEqual: returns YEStrue.

    Discussion

    This method logs a warning if usesDataSource returns YEStrue. Posts an NSComboBoxSelectionDidChangeNotification to the default notification center if the selection does in fact change. Note that this method doesn’t alter the contents of the combo box’s text field—see Setting the Combo Box’s Value in Combo Box Programming Topics for more information.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

    See Also

    – setObjectValue: (NSControl)

  • Returns a Boolean value indicating whether the receiver tries to complete what the user types in the text field.

    Declaration

    Swift

    var completes: Bool

    Objective-C

    @property BOOL completes

    Return Value

    YEStrue if the receiver tries to complete what the user types in the text field; otherwise NOfalse.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

  • Sets whether the receiver tries to complete what the user types in the text field.

    Declaration

    Swift

    var completes: Bool

    Objective-C

    @property BOOL completes

    Parameters

    completes

    YEStrue to indicate that the receiver should try to complete test entered by the user. If completes is YEStrue, every time the user adds characters to the end of the text field, the combo box calls the NSComboBoxCell method completedString:.

    Discussion

    If completedString: returns a string that’s longer than the existing string, the combo box replaces the existing string with the returned string and selects the additional characters. If the user is deleting characters or adds characters somewhere besides the end of the string, the combo box does not try to complete it.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.0 and later.

    See Also

    – completes

  • Returns the receiver’s delegate.

    Declaration

    Swift

    func delegate() -> NSComboBoxDelegate?

    Objective-C

    - (id<NSComboBoxDelegate>)delegate

    Return Value

    The receiver’s delegate.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.6 and later.

  • Sets the receiver’s delegate.

    Declaration

    Swift

    func setDelegate(_ anObject: NSComboBoxDelegate?)

    Objective-C

    - (void)setDelegate:(id<NSComboBoxDelegate>)anObject

    Parameters

    anObject

    The delegate for the receiver. The delegate must conform to the NSComboBoxDelegate Protocol protocol.

    Import Statement

    import AppKit

    Availability

    Available in OS X v10.6 and later.

    See Also

    – delegate