Back to index

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

#include <nsXFormsActionModuleBase.h>

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

List of all members.

Public Member Functions

 nsXFormsActionModuleHelper ()
 nsXFormsActionModuleHelper provides the foundation that allows event iteration to work.
virtual nsIDOMElementGetElement ()=0
PRBool CanIterate ()
void SetCurrentEvent (nsIDOMEvent *aEvent)
virtual nsresult HandleSingleAction (nsIDOMEvent *aEvent, nsIXFormsActionElement *aParentAction)=0
 With the while attribute, actions can potentially be iterated.

Protected Attributes

PRBool mCanIterate
 This signals whether or not this action can iterate.
nsCOMPtr< nsIDOMEventmCurrentEvent
 The event currently being processed.

Detailed Description

Definition at line 51 of file nsXFormsActionModuleBase.h.


Constructor & Destructor Documentation

nsXFormsActionModuleHelper provides the foundation that allows event iteration to work.

Every xforms action needs to inherit from nsXFormsActionModuleHelper in some capacity; they can inherit indirectly through nsXFormsActionModuleBase or directly from nsXFormsActionModuleHelper in the cases where the action actually needs to have binding capabilities (like nsXFormsAlertElement, etc)

Definition at line 63 of file nsXFormsActionModuleBase.h.


Member Function Documentation

Definition at line 65 of file nsXFormsActionModuleBase.h.

{ return mCanIterate; }

Here is the caller graph for this function:

Implemented in nsXFormsMessageElement, nsXFormsActionModuleBase, and nsXFormsActionElement.

Here is the caller graph for this function:

virtual nsresult nsXFormsActionModuleHelper::HandleSingleAction ( nsIDOMEvent aEvent,
nsIXFormsActionElement aParentAction 
) [pure virtual]

With the while attribute, actions can potentially be iterated.

The HandleSingleAction method processes one iteration of an action (that is, the "body" of the action); it should be dispatched by the HandleAction method, which manages the conditional execution and iteration of the action.

Implemented in nsXFormsMessageElement, nsXFormsInsertDeleteElement, nsXFormsActionElement, nsXFormsSetIndexElement, nsXFormsSetValueElement, nsXFormsToggleElement, nsXFormsDispatchElement, nsXFormsLoadElement, nsXFormsSetFocusElement, nsXFormsSendElement, nsXFormsRebuildElement, nsXFormsRecalculateElement, nsXFormsRefreshElement, nsXFormsResetElement, and nsXFormsRevalidateElement.

Here is the caller graph for this function:

Definition at line 66 of file nsXFormsActionModuleBase.h.

{ mCurrentEvent = aEvent; }

Here is the caller graph for this function:


Member Data Documentation

This signals whether or not this action can iterate.

Technically, all XForms 1.1 actions are allowed to iterate, but for some of them it may not make sense. Currently, this is set to PR_TRUE for all actions, but we can optionally disable iteration for specific actions based upon additional information in the future.

Definition at line 85 of file nsXFormsActionModuleBase.h.

The event currently being processed.

Definition at line 90 of file nsXFormsActionModuleBase.h.


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