Up

# NSArrayController

### Authors

Fred Kiefer (`fredkiefer@gmx.de`)

> Controller class for arrays

Copyright: (C) (C) 2006, 2020 Free Software Foundation, Inc.

# Software documentation for the NSArrayController class

## NSArrayController : NSObjectController

> Declared in:
>   AppKit/NSArrayController.h

Availability: MacOS-X 10.3.0
Description forthcoming.

Instance Variables
Method summary

- -addObject:
- -addObjects:
- -addSelectedObjects:
- -addSelectionIndexes:
- -alwaysUsesMultipleValuesMarker
- -arrangeObjects:
- -arrangedObjects
- -automaticallyRearrangesObjects
- -avoidsEmptySelection
- -canInsert
- -canSelectNext
- -canSelectPrevious
- -clearsFilterPredicateOnInsertion
- -filterPredicate
- -insert:
- -insertObject:atArrangedObjectIndex:
- -insertObjects:atArrangedObjectIndexes:
- -preservesSelection
- -rearrangeObjects
- -removeObject:
- -removeObjectAtArrangedObjectIndex:
- -removeObjects:
- -removeObjectsAtArrangedObjectIndexes:
- -removeSelectedObjects:
- -removeSelectionIndexes:
- -selectNext:
- -selectPrevious:
- -selectedObjects
- -selectionIndex
- -selectionIndexes
- -selectsInsertedObjects
- -setAlwaysUsesMultipleValuesMarker:
- -setAutomaticallyRearrangesObjects:
- -setAvoidsEmptySelection:
- -setClearsFilterPredicateOnInsertion:
- -setFilterPredicate:
- -setPreservesSelection:
- -setSelectedObjects:
- -setSelectionIndex:
- -setSelectionIndexes:
- -setSelectsInsertedObjects:
- -setSortDescriptors:
- -sortDescriptors

### addObject:

- (void) addObject: (id)obj;
Availability: MacOS-X 10.3.0
Description forthcoming.

### addObjects:

- (void) addObjects: (NSArray*)obj;
Availability: MacOS-X 10.3.0
Description forthcoming.

### addSelectedObjects:

- (BOOL) addSelectedObjects: (NSArray*)obj;
Availability: MacOS-X 10.3.0
Description forthcoming.

### addSelectionIndexes:

- (BOOL) addSelectionIndexes: (NSIndexSet*)idx;
Availability: MacOS-X 10.3.0
Description forthcoming.

### alwaysUsesMultipleValuesMarker

- (BOOL) alwaysUsesMultipleValuesMarker;
Availability: MacOS-X 10.4.0
Description forthcoming.

### arrangeObjects:

- (NSArray*) arrangeObjects: (NSArray*)obj;
Availability: MacOS-X 10.3.0
Description forthcoming.

### arrangedObjects

- (id) arrangedObjects;
Availability: MacOS-X 10.3.0
Description forthcoming.

### automaticallyRearrangesObjects

- (BOOL) automaticallyRearrangesObjects;
Availability: MacOS-X 10.5.0
Description forthcoming.

### avoidsEmptySelection

- (BOOL) avoidsEmptySelection;
Availability: MacOS-X 10.3.0
Description forthcoming.

### canInsert

- (BOOL) canInsert;
Availability: MacOS-X 10.3.0
Description forthcoming.

### canSelectNext

- (BOOL) canSelectNext;
Availability: MacOS-X 10.3.0
Description forthcoming.

### canSelectPrevious

- (BOOL) canSelectPrevious;
Availability: MacOS-X 10.3.0
Description forthcoming.

### clearsFilterPredicateOnInsertion

- (BOOL) clearsFilterPredicateOnInsertion;
Availability: MacOS-X 10.4.0
Description forthcoming.

### filterPredicate

- (NSPredicate*) filterPredicate;
Availability: MacOS-X 10.4.0
Description forthcoming.

### insert:

- (void) insert: (id)sender;
Availability: MacOS-X 10.3.0
Description forthcoming.

### insertObject: atArrangedObjectIndex:

- (void) insertObject: (id)obj atArrangedObjectIndex: (NSUInteger)idx;
Availability: MacOS-X 10.3.0
Description forthcoming.

### insertObjects: atArrangedObjectIndexes:

- (void) insertObjects: (NSArray*)obj atArrangedObjectIndexes: (NSIndexSet*)idx;
Availability: MacOS-X 10.3.0
Description forthcoming.

### preservesSelection

- (BOOL) preservesSelection;
Availability: MacOS-X 10.3.0
Description forthcoming.

### rearrangeObjects

- (void) rearrangeObjects;
Availability: MacOS-X 10.3.0
Description forthcoming.

### removeObject:

- (void) removeObject: (id)obj;
Availability: MacOS-X 10.3.0
Description forthcoming.

### removeObjectAtArrangedObjectIndex:

- (void) removeObjectAtArrangedObjectIndex: (NSUInteger)idx;
Availability: MacOS-X 10.3.0
Description forthcoming.

### removeObjects:

- (void) removeObjects: (NSArray*)obj;
Availability: MacOS-X 10.3.0
Description forthcoming.

### removeObjectsAtArrangedObjectIndexes:

- (void) removeObjectsAtArrangedObjectIndexes: (NSIndexSet*)idx;
Availability: MacOS-X 10.3.0
Description forthcoming.

### removeSelectedObjects:

- (BOOL) removeSelectedObjects: (NSArray*)obj;
Availability: MacOS-X 10.3.0
Description forthcoming.

### removeSelectionIndexes:

- (BOOL) removeSelectionIndexes: (NSIndexSet*)idx;
Availability: MacOS-X 10.3.0
Description forthcoming.

### selectNext:

- (void) selectNext: (id)sender;
Availability: MacOS-X 10.3.0
Description forthcoming.

### selectPrevious:

- (void) selectPrevious: (id)sender;
Availability: MacOS-X 10.3.0
Description forthcoming.

### selectedObjects

- (NSArray*) selectedObjects;
Availability: MacOS-X 10.3.0
Description forthcoming.

### selectionIndex

- (NSUInteger) selectionIndex;
Availability: MacOS-X 10.3.0
Description forthcoming.

### selectionIndexes

- (NSIndexSet*) selectionIndexes;
Availability: MacOS-X 10.3.0
Description forthcoming.

### selectsInsertedObjects

- (BOOL) selectsInsertedObjects;
Availability: MacOS-X 10.3.0
Description forthcoming.

### setAlwaysUsesMultipleValuesMarker:

- (void) setAlwaysUsesMultipleValuesMarker: (BOOL)flag;
Availability: MacOS-X 10.4.0
Description forthcoming.

### setAutomaticallyRearrangesObjects:

- (void) setAutomaticallyRearrangesObjects: (BOOL)flag;
Availability: MacOS-X 10.5.0
Description forthcoming.

### setAvoidsEmptySelection:

- (void) setAvoidsEmptySelection: (BOOL)flag;
Availability: MacOS-X 10.3.0
Description forthcoming.

### setClearsFilterPredicateOnInsertion:

- (void) setClearsFilterPredicateOnInsertion: (BOOL)flag;
Availability: MacOS-X 10.4.0
Description forthcoming.

### setFilterPredicate:

- (void) setFilterPredicate: (NSPredicate*)filterPredicate;
Availability: MacOS-X 10.4.0
Description forthcoming.

### setPreservesSelection:

- (void) setPreservesSelection: (BOOL)flag;
Availability: MacOS-X 10.3.0
Description forthcoming.

### setSelectedObjects:

- (BOOL) setSelectedObjects: (NSArray*)obj;
Availability: MacOS-X 10.3.0
Description forthcoming.

### setSelectionIndex:

- (BOOL) setSelectionIndex: (NSUInteger)idx;
Availability: MacOS-X 10.3.0
Description forthcoming.

### setSelectionIndexes:

- (BOOL) setSelectionIndexes: (NSIndexSet*)idx;
Availability: MacOS-X 10.3.0
Description forthcoming.

### setSelectsInsertedObjects:

- (void) setSelectsInsertedObjects: (BOOL)flag;
Availability: MacOS-X 10.3.0
Description forthcoming.

### setSortDescriptors:

- (void) setSortDescriptors: (NSArray*)desc;
Availability: MacOS-X 10.3.0
Description forthcoming.

### sortDescriptors

- (NSArray*) sortDescriptors;
Availability: MacOS-X 10.3.0
Description forthcoming.

## Instance Variables for NSArrayController Class

### _arranged_objects

@protected NSArray* _arranged_objects;
Availability: MacOS-X 10.3.0
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _filter_predicate

@protected NSPredicate* _filter_predicate;
Availability: MacOS-X 10.3.0
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _selection_indexes

@protected NSIndexSet* _selection_indexes;
Availability: MacOS-X 10.3.0
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### _sort_descriptors

@protected NSArray* _sort_descriptors;
Availability: MacOS-X 10.3.0
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

### struct GSArrayControllerFlagsType

@protected struct GSArrayControllerFlagsType struct GSArrayControllerFlagsType;
Availability: MacOS-X 10.3.0
Description forthcoming.

Up