Public Member Functions | Public Attributes

nsIVariant Interface Reference

XPConnect has magic to transparently convert between nsIVariant and JS types. More...

import "nsIVariant.idl";

Inheritance diagram for nsIVariant:

List of all members.

Public Member Functions

PRUint8 getAsInt8 ()
PRInt16 getAsInt16 ()
PRInt32 getAsInt32 ()
PRInt64 getAsInt64 ()
PRUint8 getAsUint8 ()
PRUint16 getAsUint16 ()
PRUint32 getAsUint32 ()
PRUint64 getAsUint64 ()
float getAsFloat ()
double getAsDouble ()
PRBool getAsBool ()
char getAsChar ()
wchar getAsWChar ()
nsresult getAsID (out nsID retval)
AString getAsAString ()
DOMString getAsDOMString ()
ACString getAsACString ()
AUTF8String getAsAUTF8String ()
string getAsString ()
wstring getAsWString ()
nsISupports getAsISupports ()
jsval getAsJSVal ()
void getAsInterface (out nsIIDPtr iid,[iid_is(iid), retval] out nsQIResult iface)
nsresult getAsArray (out PRUint16 type, out nsIID iid, out PRUint32 count, out voidPtr ptr)
void getAsStringWithSize (out PRUint32 size,[size_is(size), retval] out string str)
void getAsWStringWithSize (out PRUint32 size,[size_is(size), retval] out wstring str)

Public Attributes

readonly attribute PRUint16 dataType

Detailed Description

XPConnect has magic to transparently convert between nsIVariant and JS types.

We mark the interface [scriptable] so that JS can use methods that refer to this interface. But we mark all the methods and attributes [noscript] since any nsIVariant object will be automatically converted to a JS type anyway.


Member Function Documentation

ACString nsIVariant::getAsACString (  ) 
nsresult nsIVariant::getAsArray ( out PRUint16  type,
out nsIID  iid,
out PRUint32  count,
out voidPtr  ptr 
)
AString nsIVariant::getAsAString (  ) 
AUTF8String nsIVariant::getAsAUTF8String (  ) 
PRBool nsIVariant::getAsBool (  ) 
char nsIVariant::getAsChar (  ) 
DOMString nsIVariant::getAsDOMString (  ) 
double nsIVariant::getAsDouble (  ) 
float nsIVariant::getAsFloat (  ) 
nsresult nsIVariant::getAsID ( out nsID  retval  ) 
PRInt16 nsIVariant::getAsInt16 (  ) 
PRInt32 nsIVariant::getAsInt32 (  ) 
PRInt64 nsIVariant::getAsInt64 (  ) 
PRUint8 nsIVariant::getAsInt8 (  ) 
void nsIVariant::getAsInterface ( out nsIIDPtr  iid,
[iid_is(iid), retval] out nsQIResult  iface 
)
nsISupports nsIVariant::getAsISupports (  ) 
jsval nsIVariant::getAsJSVal (  ) 
string nsIVariant::getAsString (  ) 
void nsIVariant::getAsStringWithSize ( out PRUint32  size,
[size_is(size), retval] out string  str 
)
PRUint16 nsIVariant::getAsUint16 (  ) 
PRUint32 nsIVariant::getAsUint32 (  ) 
PRUint64 nsIVariant::getAsUint64 (  ) 
PRUint8 nsIVariant::getAsUint8 (  ) 
wchar nsIVariant::getAsWChar (  ) 
wstring nsIVariant::getAsWString (  ) 
void nsIVariant::getAsWStringWithSize ( out PRUint32  size,
[size_is(size), retval] out wstring  str 
)

Member Data Documentation

readonly attribute PRUint16 nsIVariant::dataType

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