Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsDataDocumentContentPolicy Class Reference

#include <nsDataDocumentContentPolicy.h>

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

List of all members.

Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_NSICONTENTPOLICY 
nsDataDocumentContentPolicy ()
 ~nsDataDocumentContentPolicy ()
short shouldLoad (in unsigned long aContentType, in nsIURI aContentLocation, in nsIURI aRequestOrigin, in nsISupports aContext, in ACString aMimeTypeGuess, in nsISupports aExtra)
 Should the resource at this location be loaded? ShouldLoad will be called before loading the resource at aContentLocation to determine whether to start the load at all.
short shouldProcess (in unsigned long aContentType, in nsIURI aContentLocation, in nsIURI aRequestOrigin, in nsISupports aContext, in ACString aMimeType, in nsISupports aExtra)
 Should the resource be processed? ShouldProcess will be called once all the information passed to it has been determined about the resource, typically after part of the resource has been loaded.

Public Attributes

const unsigned long TYPE_OTHER = 1
const unsigned long TYPE_SCRIPT = 2
 Indicates an executable script (such as JavaScript).
const unsigned long TYPE_IMAGE = 3
 Indicates an image (e.g., IMG elements).
const unsigned long TYPE_STYLESHEET = 4
 Indicates a stylesheet (e.g., STYLE elements).
const unsigned long TYPE_OBJECT = 5
 Indicates a generic object (plugin-handled content typically falls under this category).
const unsigned long TYPE_DOCUMENT = 6
 Indicates a document at the top-level (i.e., in a browser).
const unsigned long TYPE_SUBDOCUMENT = 7
 Indicates a document contained within another document (e.g., IFRAMEs, FRAMES, and OBJECTs).
const unsigned long TYPE_REFRESH = 8
 Indicates a timed refresh.
const short REJECT_REQUEST = -1
 Returned from shouldLoad or shouldProcess if the load or process request is rejected based on details of the request.
const short REJECT_TYPE = -2
 Returned from shouldLoad or shouldProcess if the load/process is rejected based solely on its type (of the above flags).
const short REJECT_SERVER = -3
 Returned from shouldLoad or shouldProcess if the load/process is rejected based on the server it is hosted on or requested from (aContentLocation or aRequestOrigin), e.g., if you block an IMAGE because it is served from goatse.cx (even if you don't necessarily block other types from that server/domain).
const short REJECT_OTHER = -4
 Returned from shouldLoad or shouldProcess if the load/process is rejected based on some other criteria.
const short ACCEPT = 1
 Returned from shouldLoad or shouldProcess if the load or process request is not rejected.

Detailed Description

Definition at line 49 of file nsDataDocumentContentPolicy.h.


Constructor & Destructor Documentation

Definition at line 55 of file nsDataDocumentContentPolicy.h.

  {}

Definition at line 57 of file nsDataDocumentContentPolicy.h.

  {}

Member Function Documentation

short nsIContentPolicy::shouldLoad ( in unsigned long  aContentType,
in nsIURI  aContentLocation,
in nsIURI  aRequestOrigin,
in nsISupports  aContext,
in ACString  aMimeTypeGuess,
in nsISupports  aExtra 
) [inherited]

Should the resource at this location be loaded? ShouldLoad will be called before loading the resource at aContentLocation to determine whether to start the load at all.

Parameters:
aContentTypethe type of content being tested. This will be one one of the TYPE_* constants.
aContentLocationthe location of the content being checked; must not be null
aRequestOriginOPTIONAL. the location of the resource that initiated this load request; can be null if inapplicable
aContextOPTIONAL. the nsIDOMNode or nsIDOMWindow that initiated the request, or something that can QI to one of those; can be null if inapplicable.
aMimeTypeGuessOPTIONAL. a guess for the requested content's MIME type, based on information available to the request initiator (e.g., an OBJECT's type attribute); does not reliably reflect the actual MIME type of the requested content
aExtraan OPTIONAL argument, pass-through for non-Gecko callers to pass extra data to callees.
Returns:
ACCEPT or REJECT_*
short nsIContentPolicy::shouldProcess ( in unsigned long  aContentType,
in nsIURI  aContentLocation,
in nsIURI  aRequestOrigin,
in nsISupports  aContext,
in ACString  aMimeType,
in nsISupports  aExtra 
) [inherited]

Should the resource be processed? ShouldProcess will be called once all the information passed to it has been determined about the resource, typically after part of the resource has been loaded.

Parameters:
aContentTypethe type of content being tested. This will be one one of the TYPE_* constants.
aContentLocationOPTIONAL; the location of the resource being requested: MAY be, e.g., a post-redirection URI for the resource.
aRequestOriginOPTIONAL. the location of the resource that initiated this load request; can be null if inapplicable
aContextOPTIONAL. the nsIDOMNode or nsIDOMWindow that initiated the request, or something that can QI to one of those; can be null if inapplicable.
aMimeTypethe MIME type of the requested resource (e.g., image/png), as reported by the networking library, if available (may be empty if inappropriate for the type, e.g., TYPE_REFRESH).
aExtraan OPTIONAL argument, pass-through for non-Gecko callers to pass extra data to callees.
Returns:
ACCEPT or REJECT_*

Member Data Documentation

const short nsIContentPolicy::ACCEPT = 1 [inherited]

Returned from shouldLoad or shouldProcess if the load or process request is not rejected.

Definition at line 146 of file nsIContentPolicy.idl.

const short nsIContentPolicy::REJECT_OTHER = -4 [inherited]

Returned from shouldLoad or shouldProcess if the load/process is rejected based on some other criteria.

Mozilla callers will handle this like REJECT_REQUEST; third-party implementors may, for example, use this to direct their own callers to consult the extra parameter for additional details.

Definition at line 140 of file nsIContentPolicy.idl.

const short nsIContentPolicy::REJECT_REQUEST = -1 [inherited]

Returned from shouldLoad or shouldProcess if the load or process request is rejected based on details of the request.

Definition at line 110 of file nsIContentPolicy.idl.

const short nsIContentPolicy::REJECT_SERVER = -3 [inherited]

Returned from shouldLoad or shouldProcess if the load/process is rejected based on the server it is hosted on or requested from (aContentLocation or aRequestOrigin), e.g., if you block an IMAGE because it is served from goatse.cx (even if you don't necessarily block other types from that server/domain).

NOTE that it is not meant to stop future requests for this server--only the current request.

Definition at line 131 of file nsIContentPolicy.idl.

const short nsIContentPolicy::REJECT_TYPE = -2 [inherited]

Returned from shouldLoad or shouldProcess if the load/process is rejected based solely on its type (of the above flags).

NOTE that it is not meant to stop future requests for this type--only the current request.

Definition at line 119 of file nsIContentPolicy.idl.

const unsigned long nsIContentPolicy::TYPE_DOCUMENT = 6 [inherited]

Indicates a document at the top-level (i.e., in a browser).

Definition at line 83 of file nsIContentPolicy.idl.

const unsigned long nsIContentPolicy::TYPE_IMAGE = 3 [inherited]

Indicates an image (e.g., IMG elements).

Definition at line 67 of file nsIContentPolicy.idl.

const unsigned long nsIContentPolicy::TYPE_OBJECT = 5 [inherited]

Indicates a generic object (plugin-handled content typically falls under this category).

Definition at line 78 of file nsIContentPolicy.idl.

const unsigned long nsIContentPolicy::TYPE_OTHER = 1 [inherited]

Definition at line 57 of file nsIContentPolicy.idl.

const unsigned long nsIContentPolicy::TYPE_REFRESH = 8 [inherited]

Indicates a timed refresh.

shouldLoad will never get this, because it does not represent content to be loaded (the actual load triggered by the refresh will go through shouldLoad as expected).

shouldProcess will get this for, e.g., META Refresh elements and HTTP Refresh headers.

Definition at line 101 of file nsIContentPolicy.idl.

const unsigned long nsIContentPolicy::TYPE_SCRIPT = 2 [inherited]

Indicates an executable script (such as JavaScript).

Definition at line 62 of file nsIContentPolicy.idl.

const unsigned long nsIContentPolicy::TYPE_STYLESHEET = 4 [inherited]

Indicates a stylesheet (e.g., STYLE elements).

Definition at line 72 of file nsIContentPolicy.idl.

const unsigned long nsIContentPolicy::TYPE_SUBDOCUMENT = 7 [inherited]

Indicates a document contained within another document (e.g., IFRAMEs, FRAMES, and OBJECTs).

Definition at line 89 of file nsIContentPolicy.idl.


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