Back to index

lightning-sunbird  0.9+nobinonly
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions
nsForwardReference Class Reference

#include <nsForwardReference.h>

Inheritance diagram for nsForwardReference:
Inheritance graph
[legend]

List of all members.

Public Types

enum  Phase { eStart, eConstruction, eHookup, eDone }
 Priority codes returned from GetPhase() More...
enum  Result { eResolve_Succeeded, eResolve_Later, eResolve_Error }
 Result codes returned from Resolve() More...

Public Member Functions

virtual ~nsForwardReference ()
virtual Phase GetPhase ()=0
 Get the state in which the forward reference should be resolved.
virtual Result Resolve ()=0
 Attempt to resolve the forward reference.

Static Public Attributes

static const Phase kPasses []
 Forward references are categorized by 'priority', and all forward references in a higher priority are resolved before any reference in a lower priority.

Protected Member Functions

 nsForwardReference ()

Detailed Description

Definition at line 42 of file nsForwardReference.h.


Member Enumeration Documentation

Priority codes returned from GetPhase()

Enumerator:
eStart 

A dummy marker, used to indicate unstarted resolution.

eConstruction 

The initial pass, after which the content model will be fully built.

eHookup 

A second pass, after which all 'magic attribute' hookup will have been performed.

eDone 

A dummy marker, used in kPasses to indicate termination.

Definition at line 53 of file nsForwardReference.h.

Result codes returned from Resolve()

Enumerator:
eResolve_Succeeded 

Resolution succeeded, I'm done.

eResolve_Later 

Couldn't resolve, but try me later.

eResolve_Error 

Something bad happened, don't try again.

Definition at line 89 of file nsForwardReference.h.


Constructor & Destructor Documentation

nsForwardReference::nsForwardReference ( ) [inline, protected]

Definition at line 45 of file nsForwardReference.h.

{}
virtual nsForwardReference::~nsForwardReference ( ) [inline, virtual]

Definition at line 48 of file nsForwardReference.h.

{}

Member Function Documentation

virtual Phase nsForwardReference::GetPhase ( ) [pure virtual]

Get the state in which the forward reference should be resolved.

'eConstruction' references are all resolved before 'eHookup' references are resolved.

Returns:
the Phase in which the reference needs to be resolved

Implemented in nsXULDocument::TemplateBuilderHookup, nsXULDocument::OverlayForwardReference, and nsXULDocument::BroadcasterHookup.

Here is the caller graph for this function:

virtual Result nsForwardReference::Resolve ( ) [pure virtual]

Attempt to resolve the forward reference.

Returns:
a Result that tells the resolver how to treat the reference.

Implemented in nsXULDocument::TemplateBuilderHookup, nsXULDocument::OverlayForwardReference, and nsXULDocument::BroadcasterHookup.

Here is the caller graph for this function:


Member Data Documentation

Initial value:

Forward references are categorized by 'priority', and all forward references in a higher priority are resolved before any reference in a lower priority.

This variable specifies this ordering. The last Priority is guaranteed to be eDone.

Definition at line 75 of file nsForwardReference.h.


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