105 lines
3.8 KiB
Plaintext
105 lines
3.8 KiB
Plaintext
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Netscape Public License
|
|
* Version 1.1 (the "License"); you may not use this file except in
|
|
* compliance with the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/NPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is Mozilla Communicator client code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Alec Flett <alecf@netscape.com>
|
|
* Brian Nesse <bnesse@netscape.com>
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the NPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the NPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
/**
|
|
* The nsIPrefLocalizedString interface is simply a wrapper interface for
|
|
* nsISupportsString so the preferences service can have a unique identifier
|
|
* to distinguish between requests for normal wide strings (nsISupportsString)
|
|
* and "localized" wide strings, which get their default values from properites
|
|
* files.
|
|
*
|
|
* @see nsIPrefBranch
|
|
* @see nsISupportsString
|
|
*
|
|
* @status FROZEN
|
|
*/
|
|
|
|
[scriptable, uuid(ae419e24-1dd1-11b2-b39a-d3e5e7073802)]
|
|
interface nsIPrefLocalizedString : nsISupports
|
|
{
|
|
/**
|
|
* Provides access to string data stored in this property.
|
|
*
|
|
* @return NS_OK The operation succeeded.
|
|
* @return Other An error occured.
|
|
*/
|
|
attribute wstring data;
|
|
|
|
/**
|
|
* Used to retrieve the contents of this object into a wide string.
|
|
*
|
|
* @return wstring The string containing the data stored within this object.
|
|
*/
|
|
wstring toString();
|
|
|
|
/**
|
|
* Used to set the contents of this object.
|
|
*
|
|
* @param length The length of the string. This value should not include
|
|
* space for the null terminator, nor should it account for the
|
|
* size of a character. It should only be the number of
|
|
* characters for which there is space in the string.
|
|
* @param data The string data to be stored.
|
|
*
|
|
* @note
|
|
* This makes a copy of the string argument passed in.
|
|
*
|
|
* @return NS_OK The data was successfully stored.
|
|
*/
|
|
void setDataWithLength(in unsigned long length,
|
|
[size_is(length)] in wstring data);
|
|
};
|
|
|
|
%{C++
|
|
|
|
#define NS_PREFLOCALIZEDSTRING_CID \
|
|
{ /* {064d9cee-1dd2-11b2-83e3-d25ab0193c26} */ \
|
|
0x064d9cee, \
|
|
0x1dd2, \
|
|
0x11b2, \
|
|
{ 0x83, 0xe3, 0xd2, 0x5a, 0xb0, 0x19, 0x3c, 0x26 } \
|
|
}
|
|
|
|
#define NS_PREFLOCALIZEDSTRING_CONTRACTID "@mozilla.org/pref-localizedstring;1"
|
|
#define NS_PREFLOCALIZEDSTRING_CLASSNAME "Pref LocalizedString"
|
|
|
|
%}
|