Up
Authors
- Generated by Richard Frith-Macdonald
-
Date: Generated at 2025-12-03
- Declared in:
- AppKit/NSTreeController.h
- Conforms to:
- NSCoding
- NSCopying
Availability: MacOS-X 10.4.0
Description forthcoming.
NSTreeController declares 13 Instance Variables
- (IBAction)
add: (id)sender;
Availability: MacOS-X 10.4.0
Adds a new objeect to the tree usin the newObject
method. If the tree controller is in "object" mode,
then newObject is called to add a new node.
- (IBAction)
addChild: (id)sender;
Availability: MacOS-X 10.4.0
Adds a child to the current selection using the
newObject method. If the tree controller is in
"object" mode, then newObject is called to add a
new node.
- (BOOL)
addSelectionIndexPaths: (
NSArray*)indexPaths;
Availability: MacOS-X 10.4.0
Adds the objects in the indexPaths array to
the current selection.
- (BOOL)
alwaysUsesMultipleValuesMarker;
Availability: MacOS-X 10.4.0
BOOL that indicates if the controller returns the
multiple values marker when multiple objects have
been selected.
- (
NSTreeNode*)
arrangedObjects;
Availability: MacOS-X 10.4.0
All objects managed by this tree controller.
- (BOOL)
avoidsEmptySelection;
Availability: MacOS-X 10.4.0
If YES, requires the content array to
maintain a selection.
- (BOOL)
canAddChild;
Availability: MacOS-X 10.4.0
If YES, a child can be added.
- (BOOL)
canInsert;
Availability: MacOS-X 10.4.0
If YES, an object can be inserted.
- (BOOL)
canInsertChild;
Availability: MacOS-X 10.4.0
If YES, a child can be inserted.
- (
NSString*)
childrenKeyPath;
Availability: MacOS-X 10.4.0
Key path for children of the node. This key must be key
value compliant.
- (
NSString*)
childrenKeyPathForNode: (
NSTreeNode*)node;
Availability: MacOS-X 10.5.0
children key path for the given NSTreeNode.
- (
NSString*)
countKeyPath;
Availability: MacOS-X 10.4.0
Key value path for the flag which gives the count for
the children of this node. The path indicated here must
be key-value compliant. If count is enabled, then add:,
addChild:, remove:, removeChild: and insert: are
disabled. This key path is option since it can be
determined by the array of children retuned by
the childKeyPath. The mode the tree controller is in
when this is not specified is called "object" mode.
- (
NSString*)
countKeyPathForNode: (
NSTreeNode*)node;
Availability: MacOS-X 10.5.0
count key path for the given NSTreeNode.
- (IBAction)
insert: (id)sender;
Availability: MacOS-X 10.4.0
Insert an object created by newObject into arranged
objects. This method will only function if the
tree controller is in "object" mode.
- (IBAction)
insertChild: (id)sender;
Availability: MacOS-X 10.4.0
Inserts a child using the newObject method. This
method will fail if canInsertChild returns
NO. If the tree controller is in
"object" mode, then newObject is called to add a
new node.
- (void)
insertObject: (id)object
atArrangedObjectIndexPath: (
NSIndexPath*)indexPath;
Availability: MacOS-X 10.4.0
Insert an object created by newObject
into arranged objects. This method will only function
if the tree controller is in "object" mode.
- (void)
insertObjects: (
NSArray*)objects
atArrangedObjectIndexPaths: (
NSArray*)indexPaths;
Availability: MacOS-X 10.4.0
Inserts objects into arranged
objects at the specified
indexPaths. These arrays are expected to
be parallel and have the same number of
objects. This method will only function if
the tree controller is in "object" mode.
- (
NSString*)
leafKeyPath;
Availability: MacOS-X 10.4.0
Key value path for the flag which determins that this
is a leaf. The path indicated here must be key-value
compliant. This key path is optional as it can
be determined by the children returned by the
childrenKeyPath.
- (
NSString*)
leafKeyPathForNode: (
NSTreeNode*)node;
Availability: MacOS-X 10.5.0
leaf key path for the given NSTreeNode.
- (void)
moveNode: (
NSTreeNode*)node
toIndexPath: (
NSIndexPath*)indexPath;
Availability: MacOS-X 10.5.0
Moves node to given indexPath
Not implemented (as of 2025-12-03).
Please help us by producing an implementation
of this and donating it to the GNUstep project.
- (void)
moveNodes: (
NSArray*)nodes
toIndexPath: (
NSIndexPath*)startingIndexPath;
Availability: MacOS-X 10.5.0
Move nodes to position at
startingIndexPath
Not implemented (as of 2025-12-03).
Please help us by producing an implementation of
this and donating it to the GNUstep project.
- (BOOL)
preservesSelection;
Availability: MacOS-X 10.4.0
If YES, then preserve the current selection
when the content changes.
- (void)
rearrangeObjects;
Availability: MacOS-X 10.4.0
Causes the controller to re-sort and rearrange the
objects. This method should be called if anything
has been done that affects the list of objects in the
controller.
- (IBAction)
remove: (id)sender;
Availability: MacOS-X 10.4.0
Remove the currently selected object. This method
will only function if the tree controller is in
"object" mode.
- (void)
removeObjectAtArrangedObjectIndexPath: (
NSIndexPath*)indexPath;
Availability: MacOS-X 10.4.0
Remove the currently selected object
- (void)
removeObjectsAtArrangedObjectIndexPaths: (
NSArray*)indexPaths;
Availability: MacOS-X 10.4.0
Removes objects at the specified
indexPaths.
- (void)
removeSelectionIndexPaths: (
NSArray*)indexPaths;
Availability: MacOS-X 10.4.0
Removes selection of objects at the specified
indexPaths.
- (
NSArray*)
selectedNodes;
Availability: MacOS-X 10.5.0
Array containing all selected nodes
- (
NSArray*)
selectedObjects;
Availability: MacOS-X 10.4.0
An NSArray containing all selected objects.
- (
NSIndexPath*)
selectionIndexPath;
Availability: MacOS-X 10.4.0
The index path of the first selected object.
- (
NSArray*)
selectionIndexPaths;
Availability: MacOS-X 10.4.0
An array containing all of the currently selected
objects.
- (BOOL)
selectsInsertedObjects;
Availability: MacOS-X 10.4.0
If YES, then when an object is inserted it
is added to the selection.
- (void)
setAlwaysUsesMultipleValuesMarker: (BOOL)flag;
Availability: MacOS-X 10.4.0
Sets the flag to always use multiple values
marker.
- (void)
setAvoidsEmptySelection: (BOOL)flag;
Availability: MacOS-X 10.4.0
Sets the flag to avoid empty selection.
- (void)
setChildrenKeyPath: (
NSString*)path;
Availability: MacOS-X 10.4.0
Sets the children key path. This needs to
be key-value compliant.
- (void)
setCountKeyPath: (
NSString*)path;
Availability: MacOS-X 10.4.0
Sets the count key path. This needs to be
key-value compliant. Setting this key
path will disable add:, addChild:,
remove:, removeChild:, and insert: methods. If
this is not specified, the tree controller is in
"object" mode.
- (void)
setLeafKeyPath: (
NSString*)key;
Availability: MacOS-X 10.4.0
Sets leaf key path. This value needs to be
key-value compliant.
- (void)
setPreservesSelection: (BOOL)flag;
Availability: MacOS-X 10.4.0
Sets the preserves selection flag.
- (BOOL)
setSelectionIndexPath: (
NSIndexPath*)indexPath;
Availability: MacOS-X 10.4.0
Makes indexPath the current selection.
- (BOOL)
setSelectionIndexPaths: (
NSArray*)indexPaths;
Availability: MacOS-X 10.4.0
Makes the array indexPaths the current
selections.
- (void)
setSelectsInsertedObjects: (BOOL)flag;
Availability: MacOS-X 10.4.0
Sets the flag that determines if objects
inserted are automatically selected.
- (void)
setSortDescriptors: (
NSArray*)descriptors;
Availability: MacOS-X 10.5.0
Set the descriptors by which the content of
this tree controller is sorted.
- (
NSArray*)
sortDescriptors;
Availability: MacOS-X 10.4.0
An array containing sort descriptors used to arrange
content.
Instance Variables for NSTreeController Class
@protected BOOL
_alwaysUsesMultipleValuesMarker;
Availability: MacOS-X 10.4.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.
@protected NSTreeNode*
_arranged_objects;
Availability: MacOS-X 10.4.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.
@protected BOOL
_avoidsEmptySelection;
Availability: MacOS-X 10.4.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.
@protected BOOL
_canAddChild;
Availability: MacOS-X 10.4.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.
@protected BOOL
_canInsert;
Availability: MacOS-X 10.4.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.
@protected BOOL
_canInsertChild;
Availability: MacOS-X 10.4.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.
@protected NSString*
_childrenKeyPath;
Availability: MacOS-X 10.4.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.
@protected NSString*
_countKeyPath;
Availability: MacOS-X 10.4.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.
@protected NSString*
_leafKeyPath;
Availability: MacOS-X 10.4.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.
@protected BOOL
_preservesSelection;
Availability: MacOS-X 10.4.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.
@protected NSMutableArray*
_selection_index_paths;
Availability: MacOS-X 10.4.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.
@protected BOOL
_selectsInsertedObjects;
Availability: MacOS-X 10.4.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.
@protected NSArray*
_sortDescriptors;
Availability: MacOS-X 10.4.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.
Up