Back to index

lightning-sunbird  0.9+nobinonly
nsICaseConversion.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or 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 #ifndef nsICaseConversion_h__
00038 #define nsICaseConversion_h__
00039 
00040 
00041 #include "nsISupports.h"
00042 #include "nscore.h"
00043 #include "nsString.h"
00044 
00045 // {07D3D8E0-9614-11d2-B3AD-00805F8A6670}
00046 #define NS_ICASECONVERSION_IID \
00047 { 0x7d3d8e0, 0x9614, 0x11d2, \
00048     { 0xb3, 0xad, 0x0, 0x80, 0x5f, 0x8a, 0x66, 0x70 } }
00049 
00050 class nsICaseConversion : public nsISupports {
00051 
00052 public: 
00053 
00054   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ICASECONVERSION_IID)
00055 
00056   // Convert one Unicode character into upper case
00057   NS_IMETHOD ToUpper( PRUnichar aChar, PRUnichar* aReturn) = 0;
00058 
00059   // Convert one Unicode character into lower case
00060   NS_IMETHOD ToLower( PRUnichar aChar, PRUnichar* aReturn) = 0;
00061 
00062   // Convert one Unicode character into title case
00063   NS_IMETHOD ToTitle( PRUnichar aChar, PRUnichar* aReturn) = 0;
00064 
00065   // Convert an array of Unicode characters into upper case
00066   NS_IMETHOD ToUpper( const PRUnichar* anArray, PRUnichar* aReturn, PRUint32 aLen) = 0;
00067 
00068   // Convert an array of Unicode characters into lower case
00069   NS_IMETHOD ToLower( const PRUnichar* anArray, PRUnichar* aReturn, PRUint32 aLen) = 0;
00070 
00071   // Convert an array of Unicode characters into title case
00072   NS_IMETHOD ToTitle( const PRUnichar* anArray, PRUnichar* aReturn, 
00073                       PRUint32 aLen, PRBool aStartInWordBundary=PR_TRUE) = 0;
00074 
00075   // case-insensitive PRUnichar* comparison - aResult returns similar
00076   // to strcasecmp
00077   NS_IMETHOD CaseInsensitiveCompare(const PRUnichar* aLeft, const PRUnichar* aRight, PRUint32 aLength, PRInt32* aResult) = 0;
00078 };
00079 
00080 #endif  /* nsICaseConversion_h__ */