Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Static Public Member Functions | Public Attributes | Private Member Functions | Static Private Attributes
nsAccessibilityService Class Reference

#include <nsAccessibilityService.h>

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

List of all members.

Public Member Functions

 nsAccessibilityService ()
 nsAccessibilityService
virtual ~nsAccessibilityService ()
nsIAccessible createOuterDocAccessible (in nsIDOMNode aNode)
nsIAccessible createRootAccessible (in nsIPresShell aShell, in nsIDocument aDocument)
nsIAccessible createHTML4ButtonAccessible (in nsISupports aFrame)
nsIAccessible createXULAlertAccessible (in nsIDOMNode aNode)
nsIAccessible createHTMLAreaAccessible (in nsIWeakReference aPresShell, in nsIDOMNode aDOMNode, in nsIAccessible aAccParent)
nsIAccessible createHTMLBlockAccessible (in nsISupports aFrame)
nsIAccessible createHTMLButtonAccessible (in nsISupports aFrame)
nsIAccessible createHTMLButtonAccessibleXBL (in nsIDOMNode aNode)
nsIAccessible createHTMLAccessibleByMarkup (in nsISupports aFrame, in nsIWeakReference aWeakShell, in nsIDOMNode aDOMNode, in AString aRole)
nsIAccessible createHTMLLIAccessible (in nsISupports aFrame, in nsISupports aBulletFrame, in AString aBulletText)
nsIAccessible createHTMLCheckboxAccessible (in nsISupports aFrame)
nsIAccessible createHTMLCheckboxAccessibleXBL (in nsIDOMNode aNode)
nsIAccessible createHTMLComboboxAccessible (in nsIDOMNode aNode, in nsISupports aPresShell)
nsIAccessible createHTMLGenericAccessible (in nsISupports aFrame)
nsIAccessible createHTMLGroupboxAccessible (in nsISupports aFrame)
nsIAccessible createHTMLHRAccessible (in nsISupports aFrame)
nsIAccessible createHTMLImageAccessible (in nsISupports aFrame)
nsIAccessible createHTMLLabelAccessible (in nsISupports aFrame)
nsIAccessible createHTMLListboxAccessible (in nsIDOMNode aNode, in nsISupports aPresShell)
nsIAccessible createHTMLObjectFrameAccessible (in nsObjectFrame aFrame)
nsIAccessible createHTMLRadioButtonAccessible (in nsISupports aFrame)
nsIAccessible createHTMLRadioButtonAccessibleXBL (in nsIDOMNode aNode)
nsIAccessible createHTMLSelectOptionAccessible (in nsIDOMNode aNode, in nsIAccessible aAccParent, in nsISupports aPresShell)
nsIAccessible createHTMLTableAccessible (in nsISupports aFrame)
nsIAccessible createHTMLTableCellAccessible (in nsISupports aFrame)
nsIAccessible createHTMLTableCaptionAccessible (in nsIDOMNode aDOMNode)
nsIAccessible createHTMLTableHeadAccessible (in nsIDOMNode aDOMNode)
nsIAccessible createHTMLTextAccessible (in nsISupports aFrame)
nsIAccessible createHTMLTextFieldAccessible (in nsISupports aFrame)
nsIAccessible createXULButtonAccessible (in nsIDOMNode aNode)
nsIAccessible createXULCheckboxAccessible (in nsIDOMNode aNode)
nsIAccessible createXULColorPickerAccessible (in nsIDOMNode aNode)
nsIAccessible createXULColorPickerTileAccessible (in nsIDOMNode aNode)
nsIAccessible createXULComboboxAccessible (in nsIDOMNode aNode)
nsIAccessible createXULDropmarkerAccessible (in nsIDOMNode aNode)
nsIAccessible createXULGroupboxAccessible (in nsIDOMNode aNode)
nsIAccessible createXULImageAccessible (in nsIDOMNode aNode)
nsIAccessible createXULLinkAccessible (in nsIDOMNode aNode)
nsIAccessible createXULListboxAccessible (in nsIDOMNode aNode)
nsIAccessible createXULListitemAccessible (in nsIDOMNode aNode)
nsIAccessible createXULMenubarAccessible (in nsIDOMNode aNode)
nsIAccessible createXULMenuitemAccessible (in nsIDOMNode aNode)
nsIAccessible createXULMenupopupAccessible (in nsIDOMNode aNode)
nsIAccessible createXULMenuSeparatorAccessible (in nsIDOMNode aNode)
nsIAccessible createXULProgressMeterAccessible (in nsIDOMNode aNode)
nsIAccessible createXULStatusBarAccessible (in nsIDOMNode aNode)
nsIAccessible createXULRadioButtonAccessible (in nsIDOMNode aNode)
nsIAccessible createXULRadioGroupAccessible (in nsIDOMNode aNode)
nsIAccessible createXULSelectOptionAccessible (in nsIDOMNode aNode)
nsIAccessible createXULSelectListAccessible (in nsIDOMNode aNode)
nsIAccessible createXULTabAccessible (in nsIDOMNode aNode)
nsIAccessible createXULTabBoxAccessible (in nsIDOMNode aNode)
nsIAccessible createXULTabPanelsAccessible (in nsIDOMNode aNode)
nsIAccessible createXULTabsAccessible (in nsIDOMNode aNode)
nsIAccessible createXULTextAccessible (in nsIDOMNode aNode)
nsIAccessible createXULTextBoxAccessible (in nsIDOMNode aNode)
nsIAccessible createXULTreeAccessible (in nsIDOMNode aNode)
nsIAccessible createXULTreeColumnsAccessible (in nsIDOMNode aNode)
nsIAccessible createXULTreeColumnitemAccessible (in nsIDOMNode aNode)
nsIAccessible createXULToolbarAccessible (in nsIDOMNode aNode)
nsIAccessible createXULToolbarSeparatorAccessible (in nsIDOMNode aNode)
nsIAccessible createXULTooltipAccessible (in nsIDOMNode aNode)
nsIAccessible getAccessible (in nsIDOMNode aNode, in nsIPresShell aPresShell, in nsIWeakReference aWeakShell, inout nsIFrame frameHint, out boolean aIsHidden)
void invalidateSubtreeFor (in nsIPresShell aPresShell, in nsIContent aChangedContent, in PRUint32 aEvent)
 Invalidate the accessibility cache associated with aPresShell, for accessibles that were generated for aContainerContent and it's subtree.
nsIAccessible getAccessibleFor (in nsIDOMNode aNode)
 Return an nsIAccessible for a DOM node in pres shell 0.
nsIAccessible getAccessibleInWindow (in nsIDOMNode aNode, in nsIDOMWindow aDOMWin)
 Return an nsIAccessible for a DOM node in pres shell for this DOM window.
nsIAccessible getAccessibleInWeakShell (in nsIDOMNode aNode, in nsIWeakReference aPresShell)
 Return an nsIAccessible for a DOM node in the given weak shell.
nsIAccessible getAccessibleInShell (in nsIDOMNode aNode, in nsIPresShell aPresShell)
 Return an nsIAccessible for a DOM node in the given pres shell.
nsIAccessNode getCachedAccessNode (in nsIDOMNode aNode, in nsIWeakReference aShell)
 Return an nsIAccessNode for an already created DOM node in the given weak shell.
nsIAccessible getCachedAccessible (in nsIDOMNode aNode, in nsIWeakReference aShell)
 Return an nsIAccessible for an already created DOM node in the given weak shell.
void observe (in nsISupports aSubject, in string aTopic, in wstring aData)
 Observe will be called when there is a notification for the topic |aTopic|.
void onStateChange (in nsIWebProgress aWebProgress, in nsIRequest aRequest, in unsigned long aStateFlags, in nsresult aStatus)
 Notification indicating the state has changed for one of the requests associated with aWebProgress.
void onProgressChange (in nsIWebProgress aWebProgress, in nsIRequest aRequest, in long aCurSelfProgress, in long aMaxSelfProgress, in long aCurTotalProgress, in long aMaxTotalProgress)
 Notification that the progress has changed for one of the requests associated with aWebProgress.
void onLocationChange (in nsIWebProgress aWebProgress, in nsIRequest aRequest, in nsIURI aLocation)
 Called when the location of the window being watched changes.
void onStatusChange (in nsIWebProgress aWebProgress, in nsIRequest aRequest, in nsresult aStatus, in wstring aMessage)
 Notification that the status of a request has changed.
void onSecurityChange (in nsIWebProgress aWebProgress, in nsIRequest aRequest, in unsigned long aState)
 Notification called for security progress.

Static Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_NSIACCESSIBLERETRIEVAL
NS_DECL_NSIACCESSIBILITYSERVICE
NS_DECL_NSIOBSERVER static
NS_DECL_NSIWEBPROGRESSLISTENER
nsresult 
GetShellFromNode (nsIDOMNode *aNode, nsIWeakReference **weakShell)
static nsresult GetAccessibilityService (nsIAccessibilityService **aResult)

Public Attributes

const unsigned long STATE_START = 0x00000001
 State Transition Flags.
const unsigned long STATE_REDIRECTING = 0x00000002
const unsigned long STATE_TRANSFERRING = 0x00000004
const unsigned long STATE_NEGOTIATING = 0x00000008
const unsigned long STATE_STOP = 0x00000010
const unsigned long STATE_IS_REQUEST = 0x00010000
 State Type Flags.
const unsigned long STATE_IS_DOCUMENT = 0x00020000
const unsigned long STATE_IS_NETWORK = 0x00040000
const unsigned long STATE_IS_WINDOW = 0x00080000
const unsigned long STATE_RESTORING = 0x01000000
 State Modifier Flags.
const unsigned long STATE_IS_INSECURE = 0x00000004
 State Security Flags.
const unsigned long STATE_IS_BROKEN = 0x00000001
const unsigned long STATE_IS_SECURE = 0x00000002
const unsigned long STATE_SECURE_HIGH = 0x00040000
 Security Strength Flags.
const unsigned long STATE_SECURE_MED = 0x00010000
const unsigned long STATE_SECURE_LOW = 0x00020000

Private Member Functions

nsresult GetInfo (nsISupports *aFrame, nsIFrame **aRealFrame, nsIWeakReference **aShell, nsIDOMNode **aContent)
void GetOwnerFor (nsIPresShell *aPresShell, nsIPresShell **aOwnerShell, nsIContent **aOwnerContent)
nsIContentFindContentForDocShell (nsIPresShell *aPresShell, nsIContent *aContent, nsIDocShell *aDocShell)
nsresult InitAccessible (nsIAccessible *aAccessibleIn, nsIAccessible **aAccessibleOut)

Static Private Attributes

static nsAccessibilityServicegAccessibilityService = nsnull

Detailed Description

Definition at line 55 of file nsAccessibilityService.h.


Constructor & Destructor Documentation

nsAccessibilityService

Definition at line 111 of file nsAccessibilityService.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Definition at line 128 of file nsAccessibilityService.cpp.

Here is the call graph for this function:


Member Function Documentation

nsIAccessible nsIAccessibilityService::createHTMLAccessibleByMarkup ( in nsISupports  aFrame,
in nsIWeakReference  aWeakShell,
in nsIDOMNode  aDOMNode,
in AString  aRole 
) [inherited]
nsIAccessible nsIAccessibilityService::createHTMLComboboxAccessible ( in nsIDOMNode  aNode,
in nsISupports  aPresShell 
) [inherited]
nsIAccessible nsIAccessibilityService::createHTMLLIAccessible ( in nsISupports  aFrame,
in nsISupports  aBulletFrame,
in AString  aBulletText 
) [inherited]
nsIAccessible nsIAccessibilityService::createHTMLListboxAccessible ( in nsIDOMNode  aNode,
in nsISupports  aPresShell 
) [inherited]
nsIAccessible nsIAccessibilityService::createHTMLSelectOptionAccessible ( in nsIDOMNode  aNode,
in nsIAccessible  aAccParent,
in nsISupports  aPresShell 
) [inherited]
nsIContent* nsAccessibilityService::FindContentForDocShell ( nsIPresShell aPresShell,
nsIContent aContent,
nsIDocShell aDocShell 
) [private]

Definition at line 2028 of file nsAccessibilityService.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

nsIAccessible nsIAccessibilityService::getAccessible ( in nsIDOMNode  aNode,
in nsIPresShell  aPresShell,
in nsIWeakReference  aWeakShell,
inout nsIFrame  frameHint,
out boolean  aIsHidden 
) [inherited]

Return an nsIAccessible for a DOM node in pres shell 0.

Create a new accessible of the appropriate type if necessary, or use one from the accessibility cache if it already exists.

Parameters:
aNodeThe DOM node to get an accessible for.
Returns:
The nsIAccessible for the given DOM node.

Return an nsIAccessible for a DOM node in the given pres shell.

Create a new accessible of the appropriate type if necessary, or use one from the accessibility cache if it already exists.

Parameters:
aNodeThe DOM node to get an accessible for.
aPresShellThe presentation shell which contains layout info for the DOM node.
Returns:
The nsIAccessible for the given DOM node.

Return an nsIAccessible for a DOM node in the given weak shell.

Create a new accessible of the appropriate type if necessary, or use one from the accessibility cache if it already exists.

Parameters:
aNodeThe DOM node to get an accessible for.
aPresShellThe presentation shell which contains layout info for the DOM node.
Returns:
The nsIAccessible for the given DOM node.

Return an nsIAccessible for a DOM node in pres shell for this DOM window.

Create a new accessible of the appropriate type if necessary, or use one from the accessibility cache if it already exists.

Parameters:
aNodeThe DOM node to get an accessible for.
aDOMWinThe DOM window containing the node.
Returns:
The nsIAccessible for the given DOM node.

Return an nsIAccessible for an already created DOM node in the given weak shell.

Does not create a new one -- only returns cached accessibles.

Parameters:
aNodeThe DOM node to get an accessible for.
aPresShellThe presentation shell which contains layout info for the DOM node.
Returns:
The nsIAccessible for the given DOM node or null if an accessible does not already exist for this DOM node.

Return an nsIAccessNode for an already created DOM node in the given weak shell.

Does not create a new one -- only returns cached access nodes.

Parameters:
aNodeThe DOM node to get an access node for.
aPresShellThe presentation shell which contains layout info for the DOM node.
Returns:
The nsIAccessNode for the given DOM node or null if an access node does not already exist for this DOM node.
nsresult nsAccessibilityService::GetInfo ( nsISupports *  aFrame,
nsIFrame **  aRealFrame,
nsIWeakReference **  aShell,
nsIDOMNode **  aContent 
) [private]

Definition at line 260 of file nsAccessibilityService.cpp.

{
  NS_ASSERTION(aFrame,"Error -- 1st argument (aFrame) is null!!");
  *aRealFrame = NS_STATIC_CAST(nsIFrame*, aFrame);
  nsCOMPtr<nsIContent> content = (*aRealFrame)->GetContent();
  nsCOMPtr<nsIDOMNode> node(do_QueryInterface(content));
  if (!content || !node)
    return NS_ERROR_FAILURE;
  *aNode = node;
  NS_IF_ADDREF(*aNode);

  nsCOMPtr<nsIDocument> document = content->GetDocument();
  if (!document)
    return NS_ERROR_FAILURE;

#ifdef DEBUG
  PRInt32 shells = document->GetNumberOfShells();
  NS_ASSERTION(shells > 0,"Error no shells!");
#endif

  // do_GetWR only works into a |nsCOMPtr| :-(
  nsCOMPtr<nsIWeakReference> weakShell =
    do_GetWeakReference(document->GetShellAt(0));
  NS_IF_ADDREF(*aShell = weakShell);

  return NS_OK;
}

Here is the call graph for this function:

void nsAccessibilityService::GetOwnerFor ( nsIPresShell aPresShell,
nsIPresShell **  aOwnerShell,
nsIContent **  aOwnerContent 
) [private]

Definition at line 289 of file nsAccessibilityService.cpp.

{
  nsCOMPtr<nsIDOMDocument> domDoc;
  aNode->GetOwnerDocument(getter_AddRefs(domDoc));
  nsCOMPtr<nsIDocument> doc(do_QueryInterface(domDoc));
  if (!doc)
    return NS_ERROR_INVALID_ARG;

  // ---- Get the pres shell ----
  nsIPresShell *shell = doc->GetShellAt(0);
  if (!shell)
    return NS_ERROR_FAILURE;

  nsCOMPtr<nsIWeakReference> weakRef(do_GetWeakReference(shell));

  *aWeakShell = weakRef;
  NS_IF_ADDREF(*aWeakShell);

  return NS_OK;
}

Here is the call graph for this function:

nsresult nsAccessibilityService::InitAccessible ( nsIAccessible aAccessibleIn,
nsIAccessible **  aAccessibleOut 
) [private]

Definition at line 1734 of file nsAccessibilityService.cpp.

{
  NS_ASSERTION(aAccessibleOut && !*aAccessibleOut, "Out param should already be cleared out");
  if (!aAccessibleIn)
    return NS_ERROR_FAILURE;

  nsCOMPtr<nsPIAccessNode> privateAccessNode = do_QueryInterface(aAccessibleIn);
  NS_ASSERTION(privateAccessNode, "All accessibles must support nsPIAccessNode");
  nsresult rv = privateAccessNode->Init(); // Add to cache, etc.
  if (NS_SUCCEEDED(rv)) {
    NS_ADDREF(*aAccessibleOut = aAccessibleIn);
  }
  return rv;
}

Here is the call graph for this function:

void nsIAccessibilityService::invalidateSubtreeFor ( in nsIPresShell  aPresShell,
in nsIContent  aChangedContent,
in PRUint32  aEvent 
) [inherited]

Invalidate the accessibility cache associated with aPresShell, for accessibles that were generated for aContainerContent and it's subtree.

The container content node for the change is passed in, rather than the changed presentation for the content node itself.

Parameters:
aPresShellThe presShell where changes occured
aChangeContentThe affected DOM content
aEventThe event from nsIAccessibleEvent that caused the change: Must be one of: EVENT_REORDER (change), EVENT_SHOW (make visible or create) or EVENT_HIDE (destroy or hide)
void nsIObserver::observe ( in nsISupports  aSubject,
in string  aTopic,
in wstring  aData 
) [inherited]

Observe will be called when there is a notification for the topic |aTopic|.

This assumes that the object implementing this interface has been registered with an observer service such as the nsIObserverService.

If you expect multiple topics/subjects, the impl is responsible for filtering.

You should not modify, add, remove, or enumerate notifications in the implemention of observe.

Parameters:
aSubject: Notification specific interface pointer.
aTopic: The notification topic or subject.
aData: Notification specific wide string. subject event.
void nsIWebProgressListener::onLocationChange ( in nsIWebProgress  aWebProgress,
in nsIRequest  aRequest,
in nsIURI  aLocation 
) [inherited]

Called when the location of the window being watched changes.

This is not when a load is requested, but rather once it is verified that the load is going to occur in the given window. For instance, a load that starts in a window might send progress and status messages for the new site, but it will not send the onLocationChange until we are sure that we are loading this new page here.

Parameters:
aWebProgressThe nsIWebProgress instance that fired the notification.
aRequestThe associated nsIRequest. This may be null in some cases.
aLocationThe URI of the location that is being loaded.
void nsIWebProgressListener::onProgressChange ( in nsIWebProgress  aWebProgress,
in nsIRequest  aRequest,
in long  aCurSelfProgress,
in long  aMaxSelfProgress,
in long  aCurTotalProgress,
in long  aMaxTotalProgress 
) [inherited]

Notification that the progress has changed for one of the requests associated with aWebProgress.

Progress totals are reset to zero when all requests in aWebProgress complete (corresponding to onStateChange being called with aStateFlags including the STATE_STOP and STATE_IS_WINDOW flags).

Parameters:
aWebProgressThe nsIWebProgress instance that fired the notification.
aRequestThe nsIRequest that has new progress.
aCurSelfProgressThe current progress for aRequest.
aMaxSelfProgressThe maximum progress for aRequest.
aCurTotalProgressThe current progress for all requests associated with aWebProgress.
aMaxTotalProgressThe total progress for all requests associated with aWebProgress.

NOTE: If any progress value is unknown, or if its value would exceed the maximum value of type long, then its value is replaced with -1.

NOTE: If the object also implements nsIWebProgressListener2 and the caller knows about that interface, this function will not be called. Instead, nsIWebProgressListener2::onProgressChange64 will be called.

void nsIWebProgressListener::onSecurityChange ( in nsIWebProgress  aWebProgress,
in nsIRequest  aRequest,
in unsigned long  aState 
) [inherited]

Notification called for security progress.

This method will be called on security transitions (eg HTTP -> HTTPS, HTTPS -> HTTP, FOO -> HTTPS) and after document load completion. It might also be called if an error occurs during network loading.

Parameters:
aWebProgressThe nsIWebProgress instance that fired the notification.
aRequestThe nsIRequest that has new security state.
aStateA value composed of the Security State Flags and the Security Strength Flags listed above. Any undefined bits are reserved for future use.

NOTE: These notifications will only occur if a security package is installed.

void nsIWebProgressListener::onStateChange ( in nsIWebProgress  aWebProgress,
in nsIRequest  aRequest,
in unsigned long  aStateFlags,
in nsresult  aStatus 
) [inherited]

Notification indicating the state has changed for one of the requests associated with aWebProgress.

Parameters:
aWebProgressThe nsIWebProgress instance that fired the notification
aRequestThe nsIRequest that has changed state.
aStateFlagsFlags indicating the new state. This value is a combination of one of the State Transition Flags and one or more of the State Type Flags defined above. Any undefined bits are reserved for future use.
aStatusError status code associated with the state change. This parameter should be ignored unless aStateFlags includes the STATE_STOP bit. The status code indicates success or failure of the request associated with the state change. NOTE: aStatus may be a success code even for server generated errors, such as the HTTP 404 error. In such cases, the request itself should be queried for extended error information (e.g., for HTTP requests see nsIHttpChannel).
void nsIWebProgressListener::onStatusChange ( in nsIWebProgress  aWebProgress,
in nsIRequest  aRequest,
in nsresult  aStatus,
in wstring  aMessage 
) [inherited]

Notification that the status of a request has changed.

The status message is intended to be displayed to the user (e.g., in the status bar of the browser).

Parameters:
aWebProgressThe nsIWebProgress instance that fired the notification.
aRequestThe nsIRequest that has new status.
aStatusThis value is not an error code. Instead, it is a numeric value that indicates the current status of the request. This interface does not define the set of possible status codes. NOTE: Some status values are defined by nsITransport and nsISocketTransport.
aMessageLocalized text corresponding to aStatus.

Member Data Documentation

Definition at line 77 of file nsAccessibilityService.h.

const unsigned long nsIWebProgressListener::STATE_IS_BROKEN = 0x00000001 [inherited]

Definition at line 205 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_IS_DOCUMENT = 0x00020000 [inherited]

Definition at line 163 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_IS_INSECURE = 0x00000004 [inherited]

State Security Flags.

These flags describe the security state reported by a call to the onSecurityChange method. These flags are mutually exclusive.

STATE_IS_INSECURE This flag indicates that the data corresponding to the request was received over an insecure channel.

STATE_IS_BROKEN This flag indicates an unknown security state. This may mean that the request is being loaded as part of a page in which some content was received over an insecure channel.

STATE_IS_SECURE This flag indicates that the data corresponding to the request was received over a secure channel. The degree of security is expressed by STATE_SECURE_HIGH, STATE_SECURE_MED, or STATE_SECURE_LOW.

Definition at line 204 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_IS_NETWORK = 0x00040000 [inherited]

Definition at line 164 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_IS_REQUEST = 0x00010000 [inherited]

State Type Flags.

These flags further describe the entity for which the state transition is occuring. These flags are NOT mutually exclusive (i.e., an onStateChange event may indicate some combination of these flags).

STATE_IS_REQUEST This flag indicates that the state transition is for a request, which includes but is not limited to document requests. (See below for a description of document requests.) Other types of requests, such as requests for inline content (e.g., images and stylesheets) are considered normal requests.

STATE_IS_DOCUMENT This flag indicates that the state transition is for a document request. This flag is set in addition to STATE_IS_REQUEST. A document request supports the nsIChannel interface and its loadFlags attribute includes the nsIChannel::LOAD_DOCUMENT_URI flag.

A document request does not complete until all requests associated with the loading of its corresponding document have completed. This includes other document requests (e.g., corresponding to HTML <iframe> elements). The document corresponding to a document request is available via the DOMWindow attribute of onStateChange's aWebProgress parameter.

STATE_IS_NETWORK This flag indicates that the state transition corresponds to the start or stop of activity in the indicated nsIWebProgress instance. This flag is accompanied by either STATE_START or STATE_STOP, and it may be combined with other State Type Flags.

Unlike STATE_IS_WINDOW, this flag is only set when activity within the nsIWebProgress instance being observed starts or stops. If activity only occurs in a child nsIWebProgress instance, then this flag will be set to indicate the start and stop of that activity.

For example, in the case of navigation within a single frame of a HTML frameset, a nsIWebProgressListener instance attached to the nsIWebProgress of the frameset window will receive onStateChange calls with the STATE_IS_NETWORK flag set to indicate the start and stop of said navigation. In other words, an observer of an outer window can determine when activity, that may be constrained to a child window or set of child windows, starts and stops.

STATE_IS_WINDOW This flag indicates that the state transition corresponds to the start or stop of activity in the indicated nsIWebProgress instance. This flag is accompanied by either STATE_START or STATE_STOP, and it may be combined with other State Type Flags.

This flag is similar to STATE_IS_DOCUMENT. However, when a document request completes, two onStateChange calls with STATE_STOP are generated. The document request is passed as aRequest to both calls. The first has STATE_IS_REQUEST and STATE_IS_DOCUMENT set, and the second has the STATE_IS_WINDOW flag set (and possibly the STATE_IS_NETWORK flag set as well -- see above for a description of when the STATE_IS_NETWORK flag may be set). This second STATE_STOP event may be useful as a way to partition the work that occurs when a document request completes.

Definition at line 162 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_IS_SECURE = 0x00000002 [inherited]

Definition at line 206 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_IS_WINDOW = 0x00080000 [inherited]

Definition at line 165 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_NEGOTIATING = 0x00000008 [inherited]

Definition at line 98 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_REDIRECTING = 0x00000002 [inherited]

Definition at line 96 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_RESTORING = 0x01000000 [inherited]

State Modifier Flags.

These flags further describe the transition which is occuring. These flags are NOT mutually exclusive (i.e., an onStateChange event may indicate some combination of these flags).

STATE_RESTORING This flag indicates that the state transition corresponds to the start or stop of activity for restoring a previously-rendered presentation. As such, there is no actual network activity associated with this request, and any modifications made to the document or presentation when it was originally loaded will still be present.

Definition at line 182 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_SECURE_HIGH = 0x00040000 [inherited]

Security Strength Flags.

These flags describe the security strength and accompany STATE_IS_SECURE in a call to the onSecurityChange method. These flags are mutually exclusive.

These flags are not meant to provide a precise description of data transfer security. These are instead intended as a rough indicator that may be used to, for example, color code a security indicator or otherwise provide basic data transfer security feedback to the user.

STATE_SECURE_HIGH This flag indicates a high degree of security.

STATE_SECURE_MED This flag indicates a medium degree of security.

STATE_SECURE_LOW This flag indicates a low degree of security.

Definition at line 229 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_SECURE_LOW = 0x00020000 [inherited]

Definition at line 231 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_SECURE_MED = 0x00010000 [inherited]

Definition at line 230 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_START = 0x00000001 [inherited]

State Transition Flags.

These flags indicate the various states that requests may transition through as they are being loaded. These flags are mutually exclusive.

For any given request, onStateChange is called once with the STATE_START flag, zero or more times with the STATE_TRANSFERRING flag or once with the STATE_REDIRECTING flag, and then finally once with the STATE_STOP flag. NOTE: For document requests, a second STATE_STOP is generated (see the description of STATE_IS_WINDOW for more details).

STATE_START This flag indicates the start of a request. This flag is set when a request is initiated. The request is complete when onStateChange is called for the same request with the STATE_STOP flag set.

STATE_REDIRECTING This flag indicates that a request is being redirected. The request passed to onStateChange is the request that is being redirected. When a redirect occurs, a new request is generated automatically to process the new request. Expect a corresponding STATE_START event for the new request, and a STATE_STOP for the redirected request.

STATE_TRANSFERRING This flag indicates that data for a request is being transferred to an end consumer. This flag indicates that the request has been targeted, and that the user may start seeing content corresponding to the request.

STATE_NEGOTIATING This flag is not used.

STATE_STOP This flag indicates the completion of a request. The aStatus parameter to onStateChange indicates the final status of the request.

Definition at line 95 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_STOP = 0x00000010 [inherited]

Definition at line 99 of file nsIWebProgressListener.idl.

const unsigned long nsIWebProgressListener::STATE_TRANSFERRING = 0x00000004 [inherited]

Definition at line 97 of file nsIWebProgressListener.idl.


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