Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes | Protected Attributes
nsXFormsModelInstanceDocuments Class Reference

Implementation of the instance node list returned by nsIXFormsModel::getInstanceDocuments. More...

#include <nsXFormsModelElement.h>

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

List of all members.

Public Member Functions

 nsXFormsModelInstanceDocuments ()
NS_DECL_ISUPPORTS
NS_DECL_NSICLASSINFO
NS_DECL_NSIDOMNODELIST void 
AddInstance (nsIInstanceElementPrivate *aInstance)
 Add an instance element.
void RemoveInstance (nsIInstanceElementPrivate *aInstance)
 Remove an instance element.
nsIInstanceElementPrivateGetInstanceAt (PRUint32 aIndex)
 Get the instance document at a given index.
void DropReferences ()
 Instructs the class to drop references to all instance elements.
nsIDOMNode item (in unsigned long index)
void getInterfaces (out PRUint32 count,[array, size_is(count), retval] out nsIIDPtr array)
 Get an ordered list of the interface ids that instances of the class promise to implement.
nsISupports getHelperForLanguage (in PRUint32 language)
 Get a language mapping specific helper object that may assist in using objects of this class in a specific lanaguage.

Public Attributes

readonly attribute unsigned long length
readonly attribute string contractID
 A contract ID through which an instance of this class can be created (or accessed as a service, if |flags & SINGLETON|), or null.
readonly attribute string classDescription
 A human readable string naming the class, or null.
readonly attribute nsCIDPtr classID
 A class ID through which an instance of this class can be created (or accessed as a service, if |flags & SINGLETON|), or null.
readonly attribute PRUint32 implementationLanguage
 Return language type from list in nsIProgrammingLanguage.
const PRUint32 SINGLETON = 1 << 0
 Bitflags for 'flags' attribute.
const PRUint32 THREADSAFE = 1 << 1
const PRUint32 MAIN_THREAD_ONLY = 1 << 2
const PRUint32 DOM_OBJECT = 1 << 3
const PRUint32 PLUGIN_OBJECT = 1 << 4
const PRUint32 EAGER_CLASSINFO = 1 << 5
const PRUint32 CONTENT_NODE = 1 << 6
 'flags' attribute bitflag: whether objects of this type implement nsIContent.
const PRUint32 RESERVED = 1 << 31
readonly attribute PRUint32 flags
readonly attribute nsCID classIDNoAlloc
 Also a class ID through which an instance of this class can be created (or accessed as a service, if |flags & SINGLETON|).

Protected Attributes

nsCOMArray
< nsIInstanceElementPrivate
mInstanceList
 The array holding the instance elements.

Detailed Description

Implementation of the instance node list returned by nsIXFormsModel::getInstanceDocuments.

Manages the list of all instance elements that belong to a given nsXFormsModelElement.

Definition at line 77 of file nsXFormsModelElement.h.


Constructor & Destructor Documentation

Definition at line 3502 of file nsXFormsModelElement.cpp.

  : mInstanceList(16)
{
}

Member Function Documentation

Add an instance element.

Parameters:
aInstanceThe new instance element

Definition at line 3537 of file nsXFormsModelElement.cpp.

{
  // always append to the end of the list.  We need to keep the elements in
  // document order since the first instance element is the default instance
  // document for the model.
  mInstanceList.AppendObject(aInst);
}

Here is the call graph for this function:

Instructs the class to drop references to all instance elements.

Definition at line 3552 of file nsXFormsModelElement.cpp.

Here is the call graph for this function:

nsISupports nsIClassInfo::getHelperForLanguage ( in PRUint32  language) [inherited]

Get a language mapping specific helper object that may assist in using objects of this class in a specific lanaguage.

For instance, if asked for the helper for nsIProgrammingLanguage::JAVASCRIPT this might return an object that can be QI'd into the nsIXPCScriptable interface to assist XPConnect in supplying JavaScript specific behavior to callers of the instance object.

see: nsIProgrammingLanguage.idl

Should return null if no helper available for given language.

Get the instance document at a given index.

Note:
Does NOT addref the returned element!
Parameters:
aIndexThe index
Returns:
The instance element (or nsnull if not found)

Definition at line 3531 of file nsXFormsModelElement.cpp.

{
  return mInstanceList.ObjectAt(aIndex);
}

Here is the call graph for this function:

void nsIClassInfo::getInterfaces ( out PRUint32  count,
[array, size_is(count), retval] out nsIIDPtr  array 
) [inherited]

Get an ordered list of the interface ids that instances of the class promise to implement.

Note that nsISupports is an implicit member of any such list and need not be included.

Should set *count = 0 and *array = null and return NS_OK if getting the list is not supported.

nsIDOMNode nsIDOMNodeList::item ( in unsigned long  index) [inherited]

Here is the caller graph for this function:

Remove an instance element.

Parameters:
aInstanceThe instance element

Definition at line 3546 of file nsXFormsModelElement.cpp.

Here is the call graph for this function:


Member Data Documentation

A human readable string naming the class, or null.

Definition at line 86 of file nsIClassInfo.idl.

readonly attribute nsCIDPtr nsIClassInfo::classID [inherited]

A class ID through which an instance of this class can be created (or accessed as a service, if |flags & SINGLETON|), or null.

Definition at line 92 of file nsIClassInfo.idl.

Also a class ID through which an instance of this class can be created (or accessed as a service, if |flags & SINGLETON|).

If the class does not have a CID, it should return NS_ERROR_NOT_AVAILABLE. This attribute exists so C++ callers can avoid allocating and freeing a CID, as would happen if they used classID.

Definition at line 130 of file nsIClassInfo.idl.

'flags' attribute bitflag: whether objects of this type implement nsIContent.

Definition at line 113 of file nsIClassInfo.idl.

A contract ID through which an instance of this class can be created (or accessed as a service, if |flags & SINGLETON|), or null.

Definition at line 81 of file nsIClassInfo.idl.

const PRUint32 nsIClassInfo::DOM_OBJECT = 1 << 3 [inherited]

Definition at line 106 of file nsIClassInfo.idl.

Definition at line 108 of file nsIClassInfo.idl.

readonly attribute PRUint32 nsIClassInfo::flags [inherited]

Definition at line 121 of file nsIClassInfo.idl.

Return language type from list in nsIProgrammingLanguage.

Definition at line 98 of file nsIClassInfo.idl.

readonly attribute unsigned long nsIDOMNodeList::length [inherited]

Definition at line 58 of file nsIDOMNodeList.idl.

Definition at line 105 of file nsIClassInfo.idl.

The array holding the instance elements.

Definition at line 118 of file nsXFormsModelElement.h.

Definition at line 107 of file nsIClassInfo.idl.

const PRUint32 nsIClassInfo::RESERVED = 1 << 31 [inherited]

Definition at line 118 of file nsIClassInfo.idl.

const PRUint32 nsIClassInfo::SINGLETON = 1 << 0 [inherited]

Bitflags for 'flags' attribute.

Definition at line 103 of file nsIClassInfo.idl.

const PRUint32 nsIClassInfo::THREADSAFE = 1 << 1 [inherited]

Definition at line 104 of file nsIClassInfo.idl.


The documentation for this class was generated from the following files: