nsIWebProgress

« XPCOM API Reference

Resumen

El interfaz nsIWebProgress es usado para agregar o quitar instancias nsIWebProgressListener para observar la carga de peticiones asíncronas (usualmente en el contexto DOM).

Las instancias nsIWebProgress pueden ser dispuestas en una configuración padre-hijo, correspondiente a la configuración padre-hijo de sus respectivas ventanas DOM. Sin embargo, en algunos casos, una instancia nsIWebProgress puede no estar asociada a una ventana DOM. La relación padre-hijo de las instancias nsIWebProgress no está hecha explícitamente para este intefaz, pero la relación puede existir en algunas implementaciones.

Una instancia nsIWebProgressListener recibe notificaciones la instancia nsIWebProgress a la cual se ha agregado y puede tambien recibir notificaciones de cualquier instancia nsIWebProgress que sea hija de la instancia nsIWebProgress.

Código del interfaz

[scriptable, uuid(570F39D0-EFD0-11d3-B093-00A024FFC08C)]
interface nsIWebProgress : nsISupports
{
  const unsigned long NOTIFY_STATE_REQUEST  = 0x00000001;
  const unsigned long NOTIFY_STATE_DOCUMENT = 0x00000002;
  const unsigned long NOTIFY_STATE_NETWORK  = 0x00000004;
  const unsigned long NOTIFY_STATE_WINDOW   = 0x00000008;
  const unsigned long NOTIFY_STATE_ALL      = 0x0000000f;

  const unsigned long NOTIFY_PROGRESS       = 0x00000010;
  const unsigned long NOTIFY_STATUS         = 0x00000020;
  const unsigned long NOTIFY_SECURITY       = 0x00000040;
  const unsigned long NOTIFY_LOCATION       = 0x00000080;

  const unsigned long NOTIFY_ALL            = 0x000000ff;

  void addProgressListener(in nsIWebProgressListener aListener,
                           in unsigned long aNotifyMask);

  void removeProgressListener(in nsIWebProgressListener aListener);

  readonly attribute nsIDOMWindow DOMWindow;

  readonly attribute PRBool isLoadingDocument;
};

Constantes

Estas lineas indican los estados de transición a observar, correspondientes a nsIWebProgressListener::onStateChange.

NOTIFY_STATE_REQUEST

Sólo recibe el evento onStateChange si el parámetro aStateFlags incluye nsIWebProgressListener::STATE_IS_REQUEST.

NOTIFY_STATE_DOCUMENT

Sólo recibe el evento onStateChange si el parámetro aStateFlags incluye nsIWebProgressListener::STATE_IS_DOCUMENT.

NOTIFY_STATE_NETWORK

Sólo recibe el evento onStateChange si el parámetro aStateFlags incluye nsIWebProgressListener::STATE_IS_NETWORK.

NOTIFY_STATE_WINDOW

Sólo recibe el evento onStateChange si el parámetro aStateFlags incluye nsIWebProgressListener::STATE_IS_WINDOW.

NOTIFY_STATE_ALL

Recibe todos los eventos onStateChange.

Estas lineas indican los otros eventos a observar, correspondientes a los otros métodos definidos en nsIWebProgressListener.

NOTIFY_PROGRESS

Recibe eventos onProgressChange.

NOTIFY_STATUS

Recibe eventos onStatusChange.

NOTIFY_SECURITY

Recibe eventos onSecurityChange.

NOTIFY_LOCATION

Recibe eventos onLocationChange.

Métodos

addProgressListener

void addProgressListener(in nsIWebProgressListener aListener,
                         in unsigned long aNotifyMask);

Registra un escucha que recibirá los eventos del progreso web.

Parámetros

aListener

El interfaz de escucha que será llamado cuando ocurra un evento de progreso.

Este objeto debe también implementar nsISupportsWeakReference.

aNotifyMask

Los tipos de notificaciones a recibir.

Excepciones

NS_ERROR_INVALID_ARG

Indica que aListener fue bien null o que no soporta referencias débiles.

NS_ERROR_FAILURE

Indica que aListener ya fué registrado.

removeProgressListener

 void removeProgressListener(in nsIWebProgressListener aListener);

Parámetros

aListener

El interfaz e escucha anteriormente registrado con un llamado a addProgressListener.

Excepciones

NS_ERROR_FAILURE

Indica que aListener no fué registrado.

Atributos

DOMWindow

atributo de sólo lectura nsIDOMWindow DOMWindow;

La ventana DOM asociada con esta instancia nsIWebProgress.

Exceptions

NS_ERROR_FAILURE

Indica que no hay un ventana DOM asociada.

isLoadingDocument

readonly attribute PRBool isLoadingDocument;

Indica si un documento está siendo cargado o no en el contexto de esta instancia nsIWebProgress.