Up
Authors
- Adam Fedor (
fedor@boulder.colorado.edu
)
-
- Richard Frith-Macdonald (
rfm@gnu.org
)
-
Date: 2006-06-04 00:42:10 -0600 (Sun, 04 Jun 2006)
Copyright: (C) 1993, 1994, 1996, 1999 Free Software Foundation, Inc.
- Declared in:
- Foundation/NSValue.h
- Conforms to:
- NSCopying
- NSCoding
Availability: OpenStep
Subclass of
NSValue
offering convenience methods for initializing from and accessing as any C primitive numeric type. On access, the value will be type-converted if necessary, using standard C conversion rules.
Method summary
+ (
NSNumber*)
numberWithBool: (BOOL)value;
Availability: OpenStep
New instance from boolean value.
+ (
NSNumber*)
numberWithChar: (signed char)value;
Availability: OpenStep
New instance from signed char value.
+ (
NSNumber*)
numberWithDouble: (double)value;
Availability: OpenStep
New instance from double value.
+ (
NSNumber*)
numberWithFloat: (float)value;
Availability: OpenStep
New instance from float value.
+ (
NSNumber*)
numberWithInt: (signed int)value;
Availability: OpenStep
New instance from (signed) int value.
+ (
NSNumber*)
numberWithLong: (signed long)value;
Availability: OpenStep
New instance from (signed) long value.
+ (
NSNumber*)
numberWithLongLong: (signed long long)value;
Availability: OpenStep
New instance from (signed) long long value.
+ (
NSNumber*)
numberWithShort: (signed short)value;
Availability: OpenStep
New instance from (signed) short value.
+ (
NSNumber*)
numberWithUnsignedChar: (unsigned char)value;
Availability: OpenStep
New instance from unsigned char value.
+ (
NSNumber*)
numberWithUnsignedInt: (unsigned int)value;
Availability: OpenStep
New instance from unsigned int value.
+ (
NSNumber*)
numberWithUnsignedLong: (unsigned long)value;
Availability: OpenStep
New instance from unsigned long value.
+ (
NSNumber*)
numberWithUnsignedLongLong: (unsigned long long)value;
Availability: OpenStep
New instance from unsigned long long value.
+ (
NSNumber*)
numberWithUnsignedShort: (unsigned short)value;
Availability: OpenStep
New instance from unsigned short value.
- (BOOL)
boolValue;
Availability: OpenStep
Return value as a BOOL; this will in fact be a char value converted if necessary from type initialized with; if you wish to consider anything nonzero TRUE do not compare directly to YES
, but use '!= NO'
.
- (signed char)
charValue;
Availability: OpenStep
Returns value as a signed char, converting if necessary.
- (
NSComparisonResult)
compare: (
NSNumber*)otherNumber;
Availability: OpenStep
Compares receiver with otherNumber, using C type conversion if necessary, and returns NSOrderedAscending
, NSOrderedDescending
, or NSOrderedSame
depending on whether it is less than, greater than, or equal to otherNumber.
- (
NSString*)
description;
Availability: OpenStep
Returns the string representation of this number using a non-localised conversion (decimal point is '.' irrespective of the locale).
- (
NSString*)
descriptionWithLocale: (
NSDictionary*)locale;
Availability: OpenStep
Produces a string representation of the number. For a boolean this will be either 'true' or 'false'. For other numbers the format is produced using the initWithFormat:locale:... method of NSString, and the format depends on the type of number as follows -
- char
-
%i
- short
-
%hi
- int
-
%i
- long
-
%li
- long long
-
%lli
- unsigned char
-
%u
- unsigned short
-
%hu
- unsigned int
-
%u
- unsigned long
-
%lu
- unsigned long long
-
%llu
- float
-
%0.7g
- double
-
%0.16g
- (double)
doubleValue;
Availability: OpenStep
Returns value as a double, converting if necessary.
- (float)
floatValue;
Availability: OpenStep
Returns value as a float, converting if necessary.
- (id)
initWithBool: (BOOL)value;
Availability: OpenStep
Initialize from boolean value.
- (id)
initWithChar: (signed char)value;
Availability: OpenStep
Initialize from signed char value.
- (id)
initWithDouble: (double)value;
Availability: OpenStep
Initialize from double value.
- (id)
initWithFloat: (float)value;
Availability: OpenStep
Initialize from float value.
- (id)
initWithInt: (signed int)value;
Availability: OpenStep
Initialize from (signed) int value.
- (id)
initWithLong: (signed long)value;
Availability: OpenStep
Initialize from (signed) long value.
- (id)
initWithLongLong: (signed long long)value;
Availability: OpenStep
Initialize from (signed) long long value.
- (id)
initWithShort: (signed short)value;
Availability: OpenStep
Initialize from (signed) short value.
- (id)
initWithUnsignedChar: (unsigned char)value;
Availability: OpenStep
Initialize from unsigned char value.
- (id)
initWithUnsignedInt: (unsigned int)value;
Availability: OpenStep
Initialize from unsigned int value.
- (id)
initWithUnsignedLong: (unsigned long)value;
Availability: OpenStep
Initialize from unsigned long value.
- (id)
initWithUnsignedLongLong: (unsigned long long)value;
Availability: OpenStep
Initialize from unsigned long long value.
- (id)
initWithUnsignedShort: (unsigned short)value;
Availability: OpenStep
Initialize from unsigned short value.
- (signed int)
intValue;
Availability: OpenStep
Returns value as a (signed) int, converting if necessary.
- (BOOL)
isEqualToNumber: (
NSNumber*)otherNumber;
Availability: OpenStep
Returns whether receiver and otherNumber represent the same numerical value.
- (signed long long)
longLongValue;
Availability: OpenStep
Returns value as a (signed) long long, converting if necessary.
- (signed long)
longValue;
Availability: OpenStep
Returns value as a (signed) long, converting if necessary.
- (signed short)
shortValue;
Availability: OpenStep
Returns value as a (signed) short, converting if necessary.
- (
NSString*)
stringValue;
Availability: OpenStep
- (unsigned char)
unsignedCharValue;
Availability: OpenStep
Returns value as an unsigned char, converting if necessary.
- (unsigned int)
unsignedIntValue;
Availability: OpenStep
Returns value as an unsigned int, converting if necessary.
- (unsigned long long)
unsignedLongLongValue;
Availability: OpenStep
Returns value as an unsigned long long, converting if necessary.
- (unsigned long)
unsignedLongValue;
Availability: OpenStep
Returns value as an unsigned long, converting if necessary.
- (unsigned short)
unsignedShortValue;
Availability: OpenStep
Returns value as an unsigned short, converting if necessary.
- Declared in:
- Foundation/NSValue.h
- Conforms to:
- NSCopying
- NSCoding
Availability: OpenStep
The NSValue
class can wrap a single primitive value as an object so it can be used in the containers and other places where an object reference is needed. Once initialized, an NSValue
is immutable, and there is no NSMutableValue
class. You initialize it by giving it a pointer to the primitive value, and you should be careful this does not get freed until after the NSValue
is no longer used.
Method summary
+ (
NSValue*)
value: (const void*)value
withObjCType: (const char*)type;
Availability: OpenStep
Create new instance with specified
value (a pointer) of given
type, which is a string code obtainable through the compile-time operator
@encode(...)
. For example:
NSValue *theValue = [NSValue value: &n withObjCType: @encode(int)];
+ (
NSValue*)
valueWithBytes: (const void*)value
objCType: (const char*)type;
Availability: MacOS-X 10.0.0
Synonym for value:withObjCType:.
+ (
NSValue*)
valueWithNonretainedObject: (id)anObject;
Availability: OpenStep
Create new instance holding
anObject. This is useful if you want to add
anObject to a collection such as
NSArray
but don't want it to be retained (a weak reference).
+ (
NSValue*)
valueWithPoint: (
NSPoint)point;
Availability: OpenStep
Convenience method to create instance holding an NSPoint
structure.
+ (
NSValue*)
valueWithPointer: (const void*)pointer;
Availability: OpenStep
Convenience method to create instance holding a
pointer. Same as using
@encode(void *)
in
+value:withObjCType:
.
+ (
NSValue*)
valueWithRange: (
NSRange)range;
Availability: OpenStep
Convenience method to create instance holding an NSRange
structure.
+ (
NSValue*)
valueWithRect: (
NSRect)rect;
Availability: OpenStep
Convenience method to create instance holding an NSRect
structure.
+ (
NSValue*)
valueWithSize: (
NSSize)size;
Availability: OpenStep
Convenience method to create instance holding an NSSize
structure.
- (void)
getValue: (void*)value;
Availability: OpenStep
Copies bytes from the pointer receiver was initialized with into buffer pointed to by value. Number of bytes copied is determined by the type. If type was a void * pointer or object id, the memory address itself is copied.
- (id)
initWithBytes: (const void*)data
objCType: (const char*)type;
Availability: MacOS-X 10.0.0
This is a designated initialiser for the class.
Initialize with value of type, parallel to value:withObjCType:.
- (BOOL)
isEqualToValue: (
NSValue*)other;
Availability: MacOS-X 10.0.0
Compares this instance to another NSValue
. For equality, both contents and declared type of the two values must match.
- (id)
nonretainedObjectValue;
Availability: OpenStep
If receiver was initialized with an object ID, return it, else raises NSInternalInconsistencyException
.
- (const char*)
objCType;
Availability: OpenStep
Returns the string @encode(...)
compatible type the receiver was initialized with.
- (
NSPoint)
pointValue;
Availability: OpenStep
If receiver was initialized with an NSPoint
value, return it, else raises NSInternalInconsistencyException
.
- (void*)
pointerValue;
Availability: OpenStep
If receiver was initialized with a void * pointer, return it, else raises NSInternalInconsistencyException
.
- (
NSRange)
rangeValue;
Availability: OpenStep
If receiver was initialized with an NSRange
value, return it, else raises NSInternalInconsistencyException
.
- (
NSRect)
rectValue;
Availability: OpenStep
If receiver was initialized with an NSRect
value, return it, else raises NSInternalInconsistencyException
.
- (
NSSize)
sizeValue;
Availability: OpenStep
If receiver was initialized with an NSSize
value, return it, else raises NSInternalInconsistencyException
.
- Declared in:
- Foundation/NSValue.h
Availability: Base 0.0.0
GNUstep specific (non-standard) additions to the NSNumber class.
Method summary
+ (
NSValue*)
valueFromString: (
NSString*)string;
Availability: Base 0.0.0
Parses string as a double
, int
, or unsigned int
depending on what characters are present. Uses atof
and atoi
which don't report errors, so be careful if the string might contain an invalid value.
- Declared in:
- Foundation/NSValue.h
Availability: Base 0.0.0
Note: Defines a method that is not in the OpenStep spec, but makes subclassing easier.
Method summary
+ (Class)
valueClassWithObjCType: (const char*)type;
Availability: Base 0.0.0
Used by value: withObjCType: to determine the concrete subclass to alloc.
Up