mozilla
Your Search Results

    nsIAnnotationObserver

    Please add a summary to this article.
    1.0
    28
    Introduced
    Gecko 1.8
    Inherits from: nsISupports Last changed in Gecko 1.9 (Firefox 3)

    Method overview

    void onItemAnnotationRemoved(in long long aItemId, in AUTF8String aName);
    void onItemAnnotationSet(in long long aItemId, in AUTF8String aName);
    void onPageAnnotationRemoved(in nsIURI aURI, in AUTF8String aName);
    void onPageAnnotationSet(in nsIURI aPage, in AUTF8String aName);

    Methods

    onItemAnnotationRemoved()

    This method is called when an annotation is deleted for an item. If aName is empty, then ALL annotations for the given item have been deleted. This is not called when annotations are expired (normally happens when the application exits).

    void onItemAnnotationRemoved(
      in long long aItemId,
      in AUTF8String aName
    );
    
    Parameters
    aItemId
    The item whose annotation is to be deleted.
    aName
    The annotation name.

    onItemAnnotationSet()

    This method is called when an annotation value is set for an item. It could be a new annotation, or it could be a new value for an existing annotation.

    void onItemAnnotationSet(
      in long long aItemId,
      in AUTF8String aName
    );
    
    Parameters
    aItemId
    The item on which the annotation is to be set.
    aName
    The annotation name.

    onPageAnnotationRemoved()

    Called when an annotation is deleted for a URI. If aName is empty, then ALL annotations for the given URI have been deleted. This is not called when annotations are expired (normally happens when the application exits).

    void onPageAnnotationRemoved(
      in nsIURI aURI,
      in AUTF8String aName
    );
    
    Parameters
    aURI
    The URI whose annotation is to be deleted.
    aName
    The annotation name.

    onPageAnnotationSet()

    This method is called when an annotation value is set for a URI. It could be a new annotation, or it could be a new value for an existing annotation.

    void onPageAnnotationSet(
      in nsIURI aPage,
      in AUTF8String aName
    );
    
    Parameters
    aPage
    The URI on which the annotation is to be set.
    aName
    The annotation name.

    See also

    Document Tags and Contributors

    Contributors to this page: Arehman4, trevorh, Sheppy
    Last updated by: Sheppy,