Class: NSIndexPath

Inherits:
NSObject show all

Overview

The NSIndexPath class represents the path to a specific node in a tree of nested array collections. This path is known as an index path.

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from NSObject

#!, #!=, #!~, #, #==, #===, #=~, #Rational, #__callee__, #__method__, #__send__, #__type__, `, alloc, allocWithZone:, #autoContentAccessingProxy, autoload, autoload?, autorelease_pool, #awakeAfterUsingCoder:, binding, block_given?, caller, cancelPreviousPerformRequestsWithTarget:, cancelPreviousPerformRequestsWithTarget:selector:object:, catch, class, classFallbacksForKeyedArchiver, #classForCoder, #classForKeyedArchiver, classForKeyedUnarchiver, #clone, conformsToProtocol:, #copy, copyWithZone:, #dealloc, #define_singleton_method, description, display, #doesNotRecognizeSelector:, #dup, #enum_for, #eql?, #equal?, #extend, fail, #finalize, format, #forwardInvocation:, #forwardingTargetForSelector:, framework, #freeze, #frozen?, getpass, gets, global_variables, #init, initialize, #initialize_clone, #initialize_copy, #initialize_dup, #inspect, instanceMethodForSelector:, instanceMethodSignatureForSelector:, #instance_eval, #instance_exec, #instance_of?, #instance_variable_defined?, #instance_variable_get, #instance_variable_set, #instance_variables, instancesRespondToSelector:, isSubclassOfClass:, #is_a?, iterator?, #kind_of?, lambda, load, load_bridge_support_file, load_plist, local_variables, loop, #method, #methodForSelector:, #methodSignatureForSelector:, #methods, #mutableCopy, mutableCopyWithZone:, new, #nil?, open, p, #performSelector:onThread:withObject:waitUntilDone:, #performSelector:onThread:withObject:waitUntilDone:modes:, #performSelector:withObject:afterDelay:, #performSelector:withObject:afterDelay:inModes:, #performSelectorInBackground:withObject:, #performSelectorOnMainThread:withObject:waitUntilDone:, #performSelectorOnMainThread:withObject:waitUntilDone:modes:, print, printf, #private_methods, proc, #protected_methods, #public_method, #public_methods, #public_send, putc, puts, raise, rand, readline, readlines, #replacementObjectForCoder:, #replacementObjectForKeyedArchiver:, require, resolveClassMethod:, resolveInstanceMethod:, #respond_to?, #respond_to_missing?, select, #send, setVersion:, #singleton_methods, sprintf, srand, superclass, #taint, #tainted?, #tap, test, throw, #to_plist, #to_s, trace_var, trap, #trust, #untaint, untrace_var, #untrust, #untrusted?, version

Constructor Details

This class inherits a constructor from NSObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class NSObject

Class Method Details

+ (Object) indexPathWithIndex(index)

Creates an one-node index path.

Parameters:

  • index (Integer)

    Index of the item in node 0 to point to.

Returns:

  • (Object)

    One-node index path with index.

+ (Object) indexPathWithIndexes(indexes, length:length)

Creates an index path with one or more nodes.

Parameters:

  • indexes (Integer)

    Array of indexes to make up the index path.

  • length (Integer)

    Number of nodes to include in the index path.

Returns:

  • (Object)

    Index path with indexes up to length.

Instance Method Details

- (NSComparisonResult) compare(indexPath)

Indicates the depth-first traversal order of the receiving index path and another index path.

Parameters:

  • indexPath (NSIndexPath)

    Index path to compare.This value must not be nil. If the value is nil, the behavior is undefined.

Returns:

  • (NSComparisonResult)

    The depth-first traversal ordering of the receiving index path and indexPath.

- (Object) getIndexes(indexes)

Copies the objects contained in the index path into indexes. It is the developer’s responsibility to allocate the memory for the C array.

Parameters:

  • indexes (Integer)

    Pointer to a C array of objects of size at least the length of the index path. On return, the index path’s indexes.

Returns:

- (Integer) indexAtPosition(node)

Provides the index at a particular node in the index path.

Parameters:

  • node (Integer)

    Index value of the desired node. Node numbering starts at zero.

Returns:

  • (Integer)

    The index value at node or NSNotFound if the node is outside the range of the index path.

- (NSIndexPath) indexPathByAddingIndex(index)

Provides an index path containing the indexes in the receiving index path and another index.

Parameters:

  • index (Integer)

    Index to append to the index path’s indexes.

Returns:

- (NSIndexPath) indexPathByRemovingLastIndex

Provides an index path with the indexes in the receiving index path, excluding the last one. Returns an empty NSIndexPath instance if the receiving index path’s length is 1 or less.

Returns:

  • (NSIndexPath)

    New index path with the receiving index path’s indexes, excluding the last one.

- (Object) initWithIndex(index)

Initializes an allocated NSIndexPath object with a one-node index path.

Parameters:

  • index (Integer)

    Index of the item in node 0 to point to.

Returns:

  • (Object)

    Initialized NSIndexPath object representing a one-node index path with index.

- (Object) initWithIndexes(indexes, length:length)

Initializes an allocated NSIndexPath object with an index path of a specific length.

Parameters:

  • indexes (Integer)

    Array of indexes to make up the index path.

  • length (Integer)

    Number of nodes to include in the index path.

Returns:

- (Integer) length

Provides the number of indexes in the index path.

Returns:

  • (Integer)

    Number of indexes in the index path.