Interface nsIObserverType

This interface is implemented by an object that wants to observe an event corresponding to a topic.

Hierarchy

Methods

AddRef QueryInterface Release observe

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

observe

  • 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: nsISupports

      : Notification specific interface pointer.

    • aTopic: string

      : The notification topic or subject.

    • aData: wstring

      : Notification specific wide string. subject event.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc