mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-23 00:41:02 +00:00
9f63b8a2e6
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@36781 72102866-910b-0410-8b05-ffd578937521
129 lines
3.5 KiB
Objective-C
129 lines
3.5 KiB
Objective-C
/** Interface for NSIndexPath for GNUStep
|
|
Copyright (C) 2006 Free Software Foundation, Inc.
|
|
|
|
Written by: Richard Frith-Macdonald <rfm@gnu.org>
|
|
Created: Feb 2006
|
|
|
|
This file is part of the GNUstep Base Library.
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free
|
|
Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02111 USA.
|
|
|
|
AutogsdocSource: NSIndexPath.m
|
|
|
|
*/
|
|
|
|
#ifndef _NSIndexPath_h_GNUSTEP_BASE_INCLUDE
|
|
#define _NSIndexPath_h_GNUSTEP_BASE_INCLUDE
|
|
#import <GNUstepBase/GSVersionMacros.h>
|
|
|
|
#import <Foundation/NSObject.h>
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
#if OS_API_VERSION(MAC_OS_X_VERSION_10_4,GS_API_LATEST) && GS_API_VERSION( 10200,GS_API_LATEST)
|
|
|
|
/**
|
|
* Instances of this class represent a series of indexes into a hierarchy
|
|
* of arrays.<br />
|
|
* Each instance is a unique shared object.
|
|
*/
|
|
@interface NSIndexPath : NSObject <NSCopying, NSCoding>
|
|
{
|
|
#if GS_EXPOSE(NSIndexPath)
|
|
@private
|
|
NSUInteger _hash;
|
|
NSUInteger _length;
|
|
NSUInteger *_indexes;
|
|
#endif
|
|
#if GS_NONFRAGILE
|
|
#else
|
|
/* Pointer to private additional data used to avoid breaking ABI
|
|
* when we don't have the non-fragile ABI available.
|
|
* Use this mechanism rather than changing the instance variable
|
|
* layout (see Source/GSInternal.h for details).
|
|
*/
|
|
@private id _internal GS_UNUSED_IVAR;
|
|
#endif
|
|
}
|
|
|
|
/**
|
|
* Return a path containing the single value anIndex.
|
|
*/
|
|
+ (id) indexPathWithIndex: (NSUInteger)anIndex;
|
|
|
|
/**
|
|
* Return a path containing all the indexes in the supplied array.
|
|
*/
|
|
+ (id) indexPathWithIndexes: (NSUInteger*)indexes length: (NSUInteger)length;
|
|
|
|
/**
|
|
* Compares other with the receiver.<br />
|
|
* Returns NSOrderedSame if the two are identical.<br />
|
|
* Returns NSOrderedAscending if other is less than the receiver in a
|
|
* depth-wise comparison.<br />
|
|
* Returns NSOrderedDescending otherwise.
|
|
*/
|
|
- (NSComparisonResult) compare: (NSIndexPath*)other;
|
|
|
|
/**
|
|
* Copies all index values from the receiver into aBuffer.
|
|
*/
|
|
- (void) getIndexes: (NSUInteger*)aBuffer;
|
|
|
|
/**
|
|
* Return the index at the specified position or NSNotFound if there
|
|
* is no index at the specified position.
|
|
*/
|
|
- (NSUInteger) indexAtPosition: (NSUInteger)position;
|
|
|
|
/**
|
|
* Return path formed by adding anIndex to the receiver.
|
|
*/
|
|
- (NSIndexPath *) indexPathByAddingIndex: (NSUInteger)anIndex;
|
|
|
|
/**
|
|
* Return path formed by removing the last index from the receiver.
|
|
*/
|
|
- (NSIndexPath *) indexPathByRemovingLastIndex;
|
|
|
|
/** <init />
|
|
* Returns the shared instance containing the specified index, creating it
|
|
* and destroying the receiver if necessary.
|
|
*/
|
|
- (id) initWithIndex: (NSUInteger)anIndex;
|
|
|
|
/** <init />
|
|
* Returns the shared instance containing the specified index array,
|
|
* creating it and destroying the receiver if necessary.
|
|
*/
|
|
- (id) initWithIndexes: (NSUInteger*)indexes length: (NSUInteger)length;
|
|
|
|
/**
|
|
* Returns the number of index values present in the receiver.
|
|
*/
|
|
- (NSUInteger) length;
|
|
|
|
@end
|
|
|
|
#endif
|
|
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif
|