Back to index

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

Implementation of the nsIXFormsAccessors object. More...

#include <nsXFormsAccessors.h>

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

List of all members.

Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_NSICLASSINFO
NS_DECL_NSIXFORMSACCESSORS 
nsXFormsAccessors (nsIDelegateInternal *aDelegate, nsIDOMElement *aElement)
 Constructor.
void Destroy ()
 Called by the owning delegate when it itself is destroyed.
DOMString getValue ()
 Get the value bound to the XForms control.
void setValue (in DOMString value)
 Set the value bound to the XForms control.
boolean isReadonly ()
boolean isRelevant ()
boolean isRequired ()
boolean isValid ()
boolean hasBoundNode ()
 true, if XForms control is bound to a node in a data model.
nsIDOMNode getBoundNode ()
 Node that the control is bound to in its data model.
void setContent (in nsIDOMNode aNode, in boolean aForceUpdate)
 Used to set the complete contents of the bound node.
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 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 Member Functions

nsresult GetState (PRInt32 aState, PRBool *aStateVal)
 Checks the status of the model item properties.

Protected Attributes

nsIDelegateInternalmDelegate
 The delegate owning us.
nsIDOMElementmElement
 The control DOM element.

Detailed Description

Implementation of the nsIXFormsAccessors object.

It is always owned by a nsIXFormsDelegate.

Definition at line 52 of file nsXFormsAccessors.h.


Constructor & Destructor Documentation

NS_DECL_ISUPPORTS NS_DECL_NSICLASSINFO NS_DECL_NSIXFORMSACCESSORS nsXFormsAccessors::nsXFormsAccessors ( nsIDelegateInternal aDelegate,
nsIDOMElement aElement 
) [inline]

Constructor.

Definition at line 61 of file nsXFormsAccessors.h.

    : mDelegate(aDelegate), mElement(aElement) 
  {
  }

Member Function Documentation

Called by the owning delegate when it itself is destroyed.

Definition at line 53 of file nsXFormsAccessors.cpp.

Node that the control is bound to in its data model.

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.

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.

nsresult nsXFormsAccessors::GetState ( PRInt32  aState,
PRBool aStateVal 
) [protected]

Checks the status of the model item properties.

Parameters:
aStateThe state to check aStateVal The returned state

Definition at line 60 of file nsXFormsAccessors.cpp.

{
  NS_ENSURE_ARG_POINTER(aStateVal);
  nsCOMPtr<nsIContent> content(do_QueryInterface(mElement));
  *aStateVal = (content && (content->IntrinsicState() & aState));

  return NS_OK;
}

Here is the call graph for this function:

DOMString nsIXFormsAccessors::getValue ( ) [inherited]

Get the value bound to the XForms control.

true, if XForms control is bound to a node in a data model.

void nsIXFormsAccessors::setContent ( in nsIDOMNode  aNode,
in boolean  aForceUpdate 
) [inherited]

Used to set the complete contents of the bound node.

This function is meant to be used like setValue() except that it can be used to set more than just the first textnode contained under the bound node. If there is nothing contained under aNode, then all children of the bound node will be eliminated.

Parameters:
aNodesetContent will take the contents of aNode and copy them under the control's bound node.
aForceUpdateIndicates whether setContent should rebuild, recalculate, revalidate and refresh the model that this control is bound to prior to returning
void nsIXFormsAccessors::setValue ( in DOMString  value) [inherited]

Set the value bound to the XForms control.


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.

Definition at line 105 of file nsIClassInfo.idl.

The delegate owning us.

Definition at line 79 of file nsXFormsAccessors.h.

The control DOM element.

Definition at line 82 of file nsXFormsAccessors.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: