mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-27 10:40:50 +00:00
f13d56d8ec
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@29615 72102866-910b-0410-8b05-ffd578937521
131 lines
5.3 KiB
Objective-C
131 lines
5.3 KiB
Objective-C
/* Interface of NSFormatter class
|
|
Copyright (C) 1998 Free Software Foundation, Inc.
|
|
|
|
Written by: Richard Frith-Macdonald <richard@brainstorm.co.uk>
|
|
Created: November 1998
|
|
|
|
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.
|
|
*/
|
|
|
|
#ifndef __NSFormatter_h_GNUSTEP_BASE_INCLUDE
|
|
#define __NSFormatter_h_GNUSTEP_BASE_INCLUDE
|
|
#import <GNUstepBase/GSVersionMacros.h>
|
|
|
|
#import <Foundation/NSObject.h>
|
|
#import <Foundation/NSGeometry.h>
|
|
#import <Foundation/NSRange.h>
|
|
|
|
#if OS_API_VERSION(GS_API_MACOSX, GS_API_LATEST)
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
@class NSString, NSAttributedString, NSDictionary;
|
|
|
|
/**
|
|
* This abstract class defines the interface for classes that support
|
|
* conversion between strings and objects of various types. GNUstep
|
|
* provides two concrete implementations of this class: [NSDateFormatter]
|
|
* and [NSNumberFormatter]. Others may be implemented for specialized
|
|
* applications.
|
|
*/
|
|
@interface NSFormatter : NSObject <NSCopying, NSCoding>
|
|
|
|
/**
|
|
* This method calls [-stringForObjectValue:] then marks up the string with
|
|
* attributes if it should be displayed specially. For example, in an
|
|
* application you may want to display out-of-range dates or numbers in
|
|
* italics. This is an optional method and may return nil to indicate that
|
|
* an attributed string is not provided.
|
|
*/
|
|
- (NSAttributedString*) attributedStringForObjectValue: (id)anObject
|
|
withDefaultAttributes: (NSDictionary*)attr;
|
|
|
|
/**
|
|
* For use in applications where user interactively edits a string. If the
|
|
* version of the string for editing purposes should look different from the
|
|
* string displayed (returned by [-stringForObjectValue:] or
|
|
* [-attributedStringForObjectValue:withDefaultAttributes:]), return that
|
|
* here. For example, the edited string may contain formatting codes or
|
|
* similar that are not displayed in the final string. The default
|
|
* implementation simply returns [-stringForObjectValue:].
|
|
*/
|
|
- (NSString*) editingStringForObjectValue: (id)anObject;
|
|
|
|
/** <override-subclass />
|
|
* Primary method for converting a string to an object through parsing.
|
|
* anObject and error are output parameters; you should allocate memory for
|
|
* one pointer each for the variables passed into these methods. The
|
|
* returned object will have been created through <code>alloc-init</code>.
|
|
* If there is a problem with conversion, a constant-string description of
|
|
* what went wrong is returned through error, and NO is returned, otherwise
|
|
* YES.
|
|
*/
|
|
- (BOOL) getObjectValue: (id*)anObject
|
|
forString: (NSString*)string
|
|
errorDescription: (NSString**)error;
|
|
|
|
/**
|
|
* Checks whether partialString <em>could</em>, if it were completed, be
|
|
* parsed into a valid object. newString and error are output parameters;
|
|
* you should allocate memory for one pointer each for the variables passed
|
|
* into these methods. This method is set up to be called after every
|
|
* keystroke during user editing. If it returns NO, it optionally returns
|
|
* newString to replace what the user was editing; if it doesn't, the editor
|
|
* should delete the last character the user typed.
|
|
*/
|
|
- (BOOL) isPartialStringValid: (NSString*)partialString
|
|
newEditingString: (NSString**)newString
|
|
errorDescription: (NSString**)error;
|
|
|
|
/**
|
|
* Checks whether a change to a string leaves it a valid string that, if it
|
|
* were completed, could be parsed into a valid object. origString contains
|
|
* the string before the proposed change, and origSelRange contains the range
|
|
* that is updated in the proposed change. partialStringPtr contains the new
|
|
* string to validate and proposedSelRangePtr holds the selection range that
|
|
* will be used if the string is accepted or replaced. Basically, this method
|
|
* returns YES if partialStringPtr is valid, otherwise NO and may replace
|
|
* partialStringPtr and proposedSelectedRange with improved values, and may
|
|
* report the reason in error.
|
|
*/
|
|
- (BOOL) isPartialStringValid: (NSString**)partialStringPtr
|
|
proposedSelectedRange: (NSRange*)proposedSelRangePtr
|
|
originalString: (NSString*)origString
|
|
originalSelectedRange: (NSRange)originalSelRangePtr
|
|
errorDescription: (NSString**)error;
|
|
|
|
|
|
/** <override-subclass />
|
|
* Primary method for converting an object to a string through formatting.
|
|
* Object will be converted to string according to the formatter's
|
|
* implementation and init parameters. There is no default handling if the
|
|
* class of anObject is not what the formatter expects, and usually nil
|
|
* will be returned in this case.
|
|
*/
|
|
- (NSString*) stringForObjectValue: (id)anObject;
|
|
@end
|
|
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
#endif
|
|
|