Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIPrefLocalizedString Interface Reference

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. More...

import "nsIPrefLocalizedString.idl";

Inheritance diagram for nsIPrefLocalizedString:
Inheritance graph
[legend]
Collaboration diagram for nsIPrefLocalizedString:
Collaboration graph
[legend]

List of all members.

Public Member Functions

wstring toString ()
 Used to retrieve the contents of this object into a wide string.
void setDataWithLength (in unsigned long length,[size_is(length)] in wstring data)
 Used to set the contents of this object.

Public Attributes

attribute wstring data
 Provides access to string data stored in this property.

Detailed Description

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 also:
nsIPrefBranch
nsISupportsString

FROZEN

Definition at line 56 of file nsIPrefLocalizedString.idl.


Member Function Documentation

void nsIPrefLocalizedString::setDataWithLength ( in unsigned long  length,
[size_is(length)] in wstring  data 
)

Used to set the contents of this object.

Parameters:
lengthThe 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.
dataThe string data to be stored.
Note:
This makes a copy of the string argument passed in.
Returns:
NS_OK The data was successfully stored.

Used to retrieve the contents of this object into a wide string.

Returns:
wstring The string containing the data stored within this object.

Member Data Documentation

Provides access to string data stored in this property.

Returns:
NS_OK The operation succeeded.
Other An error occured.

Definition at line 64 of file nsIPrefLocalizedString.idl.


The documentation for this interface was generated from the following file: