Back to index

lightning-sunbird  0.9+nobinonly
NSString+Utils.h
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is Chimera code.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Netscape Communications Corporation.
00018  * Portions created by the Initial Developer are Copyright (C) 2002
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Simon Fraser <sfraser@netscape.com>
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #import <Foundation/Foundation.h>
00039 #import "nscore.h"
00040 
00041 class nsAString;
00042 
00043 typedef enum
00044 {
00045   kTruncateAtStart,
00046   kTruncateAtMiddle,
00047   kTruncateAtEnd
00048 } ETruncationType;
00049 
00050 
00051 // a category to extend NSString
00052 @interface NSString (ChimeraStringUtils)
00053 
00054 + (id)ellipsisString;
00055 + (id)stringWithPRUnichars:(const PRUnichar*)inString;
00056 + (id)stringWith_nsAString:(const nsAString&)inString;
00057 - (void)assignTo_nsAString:(nsAString&)ioString;
00058 
00059 - (NSString *)stringByRemovingCharactersInSet:(NSCharacterSet*)characterSet;
00060 - (NSString *)stringByReplacingCharactersInSet:(NSCharacterSet*)characterSet withString:(NSString*)string;
00061 - (NSString *)stringByTruncatingTo:(unsigned int)maxCharacters at:(ETruncationType)truncationType;
00062 
00063 // allocate a new unicode buffer with the contents of the current string. Caller
00064 // is responsible for freeing the buffer.
00065 - (PRUnichar*)createNewUnicodeBuffer;
00066 @end
00067 
00068 @interface NSMutableString (ChimeraMutableStringUtils)
00069 
00070 - (void)truncateTo:(unsigned)maxCharacters at:(ETruncationType)truncationType;
00071 - (void)truncateToWidth:(float)maxWidth at:(ETruncationType)truncationType withAttributes:(NSDictionary *)attributes;
00072 
00073 @end