gecko-dev/modules/libpref/nsIPrefLocalizedString.idl
Birunthan Mohanathas 0f53566ffe Bug 1047877 - Flatten modules/libpref/{public,src}/ directories. r=bsmedberg
--HG--
rename : modules/libpref/src/Makefile.in => modules/libpref/Makefile.in
rename : modules/libpref/src/Preferences.cpp => modules/libpref/Preferences.cpp
rename : modules/libpref/public/Preferences.h => modules/libpref/Preferences.h
rename : modules/libpref/src/init/all.js => modules/libpref/init/all.js
rename : modules/libpref/public/nsIPrefBranch.idl => modules/libpref/nsIPrefBranch.idl
rename : modules/libpref/public/nsIPrefBranch2.idl => modules/libpref/nsIPrefBranch2.idl
rename : modules/libpref/public/nsIPrefBranchInternal.idl => modules/libpref/nsIPrefBranchInternal.idl
rename : modules/libpref/public/nsIPrefLocalizedString.idl => modules/libpref/nsIPrefLocalizedString.idl
rename : modules/libpref/public/nsIPrefService.idl => modules/libpref/nsIPrefService.idl
rename : modules/libpref/public/nsIRelativeFilePref.idl => modules/libpref/nsIRelativeFilePref.idl
rename : modules/libpref/src/nsPrefBranch.cpp => modules/libpref/nsPrefBranch.cpp
rename : modules/libpref/src/nsPrefBranch.h => modules/libpref/nsPrefBranch.h
rename : modules/libpref/src/nsPrefsFactory.cpp => modules/libpref/nsPrefsFactory.cpp
rename : modules/libpref/src/prefapi.cpp => modules/libpref/prefapi.cpp
rename : modules/libpref/src/prefapi.h => modules/libpref/prefapi.h
rename : modules/libpref/src/prefapi_private_data.h => modules/libpref/prefapi_private_data.h
rename : modules/libpref/src/prefread.cpp => modules/libpref/prefread.cpp
rename : modules/libpref/src/prefread.h => modules/libpref/prefread.h
2014-08-07 21:52:04 -07:00

65 lines
2.1 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#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
*/
[scriptable, uuid(ae419e24-1dd1-11b2-b39a-d3e5e7073802)]
interface nsIPrefLocalizedString : nsISupports
{
/**
* Provides access to string data stored in this property.
*
* @throws Error An error occurred.
*/
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.
*/
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"
%}