mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-12-04 02:57:38 +00:00
510 lines
26 KiB
C++
510 lines
26 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either of the GNU General Public License Version 2 or later (the "GPL"),
|
|
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
#ifndef nsIDocumentObserver_h___
|
|
#define nsIDocumentObserver_h___
|
|
|
|
#include "nsISupports.h"
|
|
|
|
class nsIAtom;
|
|
class nsIContent;
|
|
class nsIPresShell;
|
|
class nsIStyleSheet;
|
|
class nsIStyleRule;
|
|
class nsString;
|
|
class nsIDocument;
|
|
|
|
#define NS_IDOCUMENT_OBSERVER_IID \
|
|
{ 0xb3f92460, 0x944c, 0x11d1, {0x93, 0x23, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32}}
|
|
|
|
typedef PRUint32 nsUpdateType;
|
|
|
|
#define UPDATE_CONTENT_MODEL 0x00000001
|
|
#define UPDATE_STYLE 0x00000002
|
|
#define UPDATE_CONTENT_STATE 0x00000004
|
|
#define UPDATE_ALL (UPDATE_CONTENT_MODEL | UPDATE_STYLE | UPDATE_CONTENT_STATE)
|
|
|
|
// Document observer interface
|
|
class nsIDocumentObserver : public nsISupports
|
|
{
|
|
public:
|
|
NS_DEFINE_STATIC_IID_ACCESSOR(NS_IDOCUMENT_OBSERVER_IID)
|
|
|
|
/**
|
|
* Notify that a content model update is beginning. This call can be
|
|
* nested.
|
|
*/
|
|
virtual void BeginUpdate(nsIDocument *aDocument,
|
|
nsUpdateType aUpdateType) = 0;
|
|
|
|
/**
|
|
* Notify that a content model update is finished. This call can be
|
|
* nested.
|
|
*/
|
|
virtual void EndUpdate(nsIDocument *aDocument, nsUpdateType aUpdateType) = 0;
|
|
|
|
/**
|
|
* Notify the observer that a document load is beginning.
|
|
*/
|
|
virtual void BeginLoad(nsIDocument *aDocument) = 0;
|
|
|
|
/**
|
|
* Notify the observer that a document load has finished. Note that
|
|
* the associated reflow of the document will be done <b>before</b>
|
|
* EndLoad is invoked, not after.
|
|
*/
|
|
virtual void EndLoad(nsIDocument *aDocument) = 0;
|
|
|
|
/**
|
|
* Notify the observer that the document is being reflowed in
|
|
* the given presentation shell.
|
|
*/
|
|
virtual void BeginReflow(nsIDocument *aDocument, nsIPresShell* aShell) = 0;
|
|
|
|
/**
|
|
* Notify the observer that the document is done being reflowed in
|
|
* the given presentation shell.
|
|
*/
|
|
virtual void EndReflow(nsIDocument *aDocument, nsIPresShell* aShell) = 0;
|
|
|
|
/**
|
|
* Notification that the content model has changed. This method is
|
|
* called automatically by content objects when their state is changed
|
|
* (therefore there is normally no need to invoke this method
|
|
* directly). The notification is passed to any
|
|
* IDocumentObservers. The notification is passed on to all of the
|
|
* document observers. <p>
|
|
*
|
|
* This notification is not sent when a piece of content is
|
|
* added/removed from the document (the other notifications are used
|
|
* for that).
|
|
*
|
|
* @param aDocument The document being observed
|
|
* @param aContent the piece of content that changed
|
|
* @param aAppend Whether the change was an append
|
|
*/
|
|
virtual void CharacterDataChanged(nsIDocument *aDocument,
|
|
nsIContent* aContent,
|
|
PRBool aAppend) = 0;
|
|
|
|
/**
|
|
* Notification that the state of a content node has changed.
|
|
* (ie: gained or lost focus, became active or hovered over)
|
|
* This method is called automatically by content objects
|
|
* when their state is changed (therefore there is normally
|
|
* no need to invoke this method directly). The notification
|
|
* is passed to any IDocumentObservers. The notification is
|
|
* passed on to all of the document observers. <p>
|
|
*
|
|
* This notification is not sent when a piece of content is
|
|
* added/removed from the document or the content itself changed
|
|
* (the other notifications are used for that).
|
|
*
|
|
* The optional second content node is to allow optimization
|
|
* of the case where state moves from one node to another
|
|
* (as is likely for :focus and :hover)
|
|
*
|
|
* Either content node may be nsnull, but not both
|
|
*
|
|
* @param aDocument The document being observed
|
|
* @param aContent1 the piece of content that changed
|
|
* @param aContent2 optional second piece of content that changed
|
|
*/
|
|
virtual void ContentStatesChanged(nsIDocument* aDocument,
|
|
nsIContent* aContent1,
|
|
nsIContent* aContent2,
|
|
PRInt32 aStateMask) = 0;
|
|
|
|
/**
|
|
* Notification that the content model has changed. This method is called
|
|
* automatically by content objects when an attribute's value has changed
|
|
* (therefore there is normally no need to invoke this method directly). The
|
|
* notification is passed to any IDocumentObservers document observers. <p>
|
|
*
|
|
* @param aDocument The document being observed
|
|
* @param aContent the piece of content whose attribute changed
|
|
* @param aAttribute the atom name of the attribute
|
|
* @param aModType Whether or not the attribute was added, changed, or removed.
|
|
* The constants are defined in nsIDOMMutationEvent.h.
|
|
*/
|
|
virtual void AttributeChanged(nsIDocument *aDocument,
|
|
nsIContent* aContent,
|
|
PRInt32 aNameSpaceID,
|
|
nsIAtom* aAttribute,
|
|
PRInt32 aModType) = 0;
|
|
|
|
/**
|
|
* Notifcation that the content model has had data appended to the
|
|
* given content object. This method is called automatically by the
|
|
* content container objects when a new content object is appended to
|
|
* the container (therefore there is normally no need to invoke this
|
|
* method directly). The notification is passed on to all of the
|
|
* document observers.
|
|
*
|
|
* @param aDocument The document being observed
|
|
* @param aContainer the container that had a new child appended
|
|
* @param aNewIndexInContainer the index in the container of the first
|
|
* new child
|
|
*/
|
|
virtual void ContentAppended(nsIDocument *aDocument,
|
|
nsIContent* aContainer,
|
|
PRInt32 aNewIndexInContainer) = 0;
|
|
|
|
/**
|
|
* Notification that content has been inserted. This method is called
|
|
* automatically by the content container objects when a new content
|
|
* object is inserted in the container (therefore there is normally no
|
|
* need to invoke this method directly). The notification is passed on
|
|
* to all of the document observers.
|
|
*
|
|
* @param aDocument The document being observed
|
|
* @param aContainer the container that now contains aChild
|
|
* @param aChild the child that was inserted
|
|
* @param aIndexInContainer the index of the child in the container
|
|
*/
|
|
virtual void ContentInserted(nsIDocument *aDocument,
|
|
nsIContent* aContainer,
|
|
nsIContent* aChild,
|
|
PRInt32 aIndexInContainer) = 0;
|
|
|
|
/**
|
|
* Content has just been removed. This method is called automatically
|
|
* by content container objects when a content object has just been
|
|
* removed from the container (therefore there is normally no need to
|
|
* invoke this method directly). The notification is passed on to all
|
|
* of the document observers.
|
|
*
|
|
* @param aDocument The document being observed
|
|
* @param aContainer the container that had a child removed
|
|
* @param aChild the child that was just removed
|
|
* @param aIndexInContainer the index of the child in the container
|
|
* before it was removed
|
|
*/
|
|
virtual void ContentRemoved(nsIDocument *aDocument,
|
|
nsIContent* aContainer,
|
|
nsIContent* aChild,
|
|
PRInt32 aIndexInContainer) = 0;
|
|
|
|
/**
|
|
* A StyleSheet has just been added to the document. This method is
|
|
* called automatically when a StyleSheet gets added to the
|
|
* document, even if the stylesheet is not applicable. The
|
|
* notification is passed on to all of the document observers.
|
|
*
|
|
* @param aDocument The document being observed
|
|
* @param aStyleSheet the StyleSheet that has been added
|
|
* @param aDocumentSheet True if sheet is in document's style sheet list,
|
|
* false if sheet is not (i.e., UA or user sheet)
|
|
*/
|
|
virtual void StyleSheetAdded(nsIDocument *aDocument,
|
|
nsIStyleSheet* aStyleSheet,
|
|
PRBool aDocumentSheet) = 0;
|
|
|
|
/**
|
|
* A StyleSheet has just been removed from the document. This
|
|
* method is called automatically when a StyleSheet gets removed
|
|
* from the document, even if the stylesheet is not applicable. The
|
|
* notification is passed on to all of the document observers.
|
|
*
|
|
* @param aDocument The document being observed
|
|
* @param aStyleSheet the StyleSheet that has been removed
|
|
* @param aDocumentSheet True if sheet is in document's style sheet list,
|
|
* false if sheet is not (i.e., UA or user sheet)
|
|
*/
|
|
virtual void StyleSheetRemoved(nsIDocument *aDocument,
|
|
nsIStyleSheet* aStyleSheet,
|
|
PRBool aDocumentSheet) = 0;
|
|
|
|
/**
|
|
* A StyleSheet has just changed its applicable state.
|
|
* This method is called automatically when the applicable state
|
|
* of a StyleSheet gets changed. The style sheet passes this
|
|
* notification to the document. The notification is passed on
|
|
* to all of the document observers.
|
|
*
|
|
* @param aDocument The document being observed
|
|
* @param aStyleSheet the StyleSheet that has changed state
|
|
* @param aApplicable PR_TRUE if the sheet is applicable, PR_FALSE if
|
|
* it is not applicable
|
|
*/
|
|
virtual void StyleSheetApplicableStateChanged(nsIDocument *aDocument,
|
|
nsIStyleSheet* aStyleSheet,
|
|
PRBool aApplicable) = 0;
|
|
|
|
/**
|
|
* A StyleRule has just been modified within a style sheet.
|
|
* This method is called automatically when the rule gets
|
|
* modified. The style sheet passes this notification to
|
|
* the document. The notification is passed on to all of
|
|
* the document observers.
|
|
*
|
|
* Since nsIStyleRule objects are immutable, there is a new object
|
|
* replacing the old one. However, the use of this method (rather
|
|
* than StyleRuleAdded and StyleRuleRemoved) implies that the new rule
|
|
* matches the same elements and has the same priority (weight,
|
|
* origin, specificity) as the old one. (However, if it is a CSS
|
|
* style rule, there may be a change in whether it has an important
|
|
* rule.)
|
|
*
|
|
* @param aDocument The document being observed
|
|
* @param aStyleSheet the StyleSheet that contians the rule
|
|
* @param aOldStyleRule The rule being removed. This rule may not be
|
|
* fully valid anymore -- however, it can still
|
|
* be used for pointer comparison and
|
|
* |QueryInterface|.
|
|
* @param aNewStyleRule The rule being added.
|
|
*/
|
|
virtual void StyleRuleChanged(nsIDocument *aDocument,
|
|
nsIStyleSheet* aStyleSheet,
|
|
nsIStyleRule* aOldStyleRule,
|
|
nsIStyleRule* aNewStyleRule) = 0;
|
|
|
|
/**
|
|
* A StyleRule has just been added to a style sheet.
|
|
* This method is called automatically when the rule gets
|
|
* added to the sheet. The style sheet passes this
|
|
* notification to the document. The notification is passed on
|
|
* to all of the document observers.
|
|
*
|
|
* @param aDocument The document being observed
|
|
* @param aStyleSheet the StyleSheet that has been modified
|
|
* @param aStyleRule the rule that was added
|
|
*/
|
|
virtual void StyleRuleAdded(nsIDocument *aDocument,
|
|
nsIStyleSheet* aStyleSheet,
|
|
nsIStyleRule* aStyleRule) = 0;
|
|
|
|
/**
|
|
* A StyleRule has just been removed from a style sheet.
|
|
* This method is called automatically when the rule gets
|
|
* removed from the sheet. The style sheet passes this
|
|
* notification to the document. The notification is passed on
|
|
* to all of the document observers.
|
|
*
|
|
* @param aDocument The document being observed
|
|
* @param aStyleSheet the StyleSheet that has been modified
|
|
* @param aStyleRule the rule that was removed
|
|
*/
|
|
virtual void StyleRuleRemoved(nsIDocument *aDocument,
|
|
nsIStyleSheet* aStyleSheet,
|
|
nsIStyleRule* aStyleRule) = 0;
|
|
|
|
/**
|
|
* The document is in the process of being destroyed.
|
|
* This method is called automatically during document
|
|
* destruction.
|
|
*
|
|
* @param aDocument The document being observed
|
|
*/
|
|
virtual void DocumentWillBeDestroyed(nsIDocument *aDocument) = 0;
|
|
};
|
|
|
|
#define NS_DECL_NSIDOCUMENTOBSERVER \
|
|
virtual void BeginUpdate(nsIDocument* aDocument, nsUpdateType aUpdateType);\
|
|
virtual void EndUpdate(nsIDocument* aDocument, nsUpdateType aUpdateType);\
|
|
virtual void BeginLoad(nsIDocument* aDocument); \
|
|
virtual void EndLoad(nsIDocument* aDocument); \
|
|
virtual void BeginReflow(nsIDocument* aDocument, \
|
|
nsIPresShell* aShell); \
|
|
virtual void EndReflow(nsIDocument* aDocument, \
|
|
nsIPresShell* aShell); \
|
|
virtual void CharacterDataChanged(nsIDocument* aDocument, \
|
|
nsIContent* aContent, \
|
|
PRBool aAppend); \
|
|
virtual void ContentStatesChanged(nsIDocument* aDocument, \
|
|
nsIContent* aContent1, \
|
|
nsIContent* aContent2, \
|
|
PRInt32 aStateMask); \
|
|
virtual void AttributeChanged(nsIDocument* aDocument, \
|
|
nsIContent* aContent, \
|
|
PRInt32 aNameSpaceID, \
|
|
nsIAtom* aAttribute, \
|
|
PRInt32 aModType); \
|
|
virtual void ContentAppended(nsIDocument* aDocument, \
|
|
nsIContent* aContainer, \
|
|
PRInt32 aNewIndexInContainer); \
|
|
virtual void ContentInserted(nsIDocument* aDocument, \
|
|
nsIContent* aContainer, \
|
|
nsIContent* aChild, \
|
|
PRInt32 aIndexInContainer); \
|
|
virtual void ContentRemoved(nsIDocument* aDocument, \
|
|
nsIContent* aContainer, \
|
|
nsIContent* aChild, \
|
|
PRInt32 aIndexInContainer); \
|
|
virtual void StyleSheetAdded(nsIDocument* aDocument, \
|
|
nsIStyleSheet* aStyleSheet, \
|
|
PRBool aDocumentSheet); \
|
|
virtual void StyleSheetRemoved(nsIDocument* aDocument, \
|
|
nsIStyleSheet* aStyleSheet, \
|
|
PRBool aDocumentSheet); \
|
|
virtual void StyleSheetApplicableStateChanged(nsIDocument* aDocument, \
|
|
nsIStyleSheet* aStyleSheet,\
|
|
PRBool aApplicable); \
|
|
virtual void StyleRuleChanged(nsIDocument* aDocument, \
|
|
nsIStyleSheet* aStyleSheet, \
|
|
nsIStyleRule* aOldStyleRule, \
|
|
nsIStyleRule* aNewStyleRule); \
|
|
virtual void StyleRuleAdded(nsIDocument* aDocument, \
|
|
nsIStyleSheet* aStyleSheet, \
|
|
nsIStyleRule* aStyleRule); \
|
|
virtual void StyleRuleRemoved(nsIDocument* aDocument, \
|
|
nsIStyleSheet* aStyleSheet, \
|
|
nsIStyleRule* aStyleRule); \
|
|
virtual void DocumentWillBeDestroyed(nsIDocument* aDocument); \
|
|
|
|
|
|
#define NS_IMPL_NSIDOCUMENTOBSERVER_CORE_STUB(_class) \
|
|
void \
|
|
_class::BeginUpdate(nsIDocument* aDocument, nsUpdateType aUpdateType) \
|
|
{ \
|
|
} \
|
|
void \
|
|
_class::EndUpdate(nsIDocument* aDocument, nsUpdateType aUpdateType) \
|
|
{ \
|
|
} \
|
|
void \
|
|
_class::DocumentWillBeDestroyed(nsIDocument* aDocument) \
|
|
{ \
|
|
}
|
|
|
|
#define NS_IMPL_NSIDOCUMENTOBSERVER_LOAD_STUB(_class) \
|
|
void \
|
|
_class::BeginLoad(nsIDocument* aDocument) \
|
|
{ \
|
|
} \
|
|
void \
|
|
_class::EndLoad(nsIDocument* aDocument) \
|
|
{ \
|
|
}
|
|
|
|
#define NS_IMPL_NSIDOCUMENTOBSERVER_REFLOW_STUB(_class) \
|
|
void \
|
|
_class::BeginReflow(nsIDocument* aDocument, \
|
|
nsIPresShell* aShell) \
|
|
{ \
|
|
} \
|
|
void \
|
|
_class::EndReflow(nsIDocument* aDocument, \
|
|
nsIPresShell* aShell) \
|
|
{ \
|
|
}
|
|
|
|
#define NS_IMPL_NSIDOCUMENTOBSERVER_STATE_STUB(_class) \
|
|
void \
|
|
_class::ContentStatesChanged(nsIDocument* aDocument, \
|
|
nsIContent* aContent1, \
|
|
nsIContent* aContent2, \
|
|
PRInt32 aStateMask) \
|
|
{ \
|
|
}
|
|
|
|
#define NS_IMPL_NSIDOCUMENTOBSERVER_CONTENT(_class) \
|
|
void \
|
|
_class::CharacterDataChanged(nsIDocument* aDocument, \
|
|
nsIContent* aContent, \
|
|
PRBool aAppend) \
|
|
{ \
|
|
} \
|
|
void \
|
|
_class::AttributeChanged(nsIDocument* aDocument, \
|
|
nsIContent* aContent, \
|
|
PRInt32 aNameSpaceID, \
|
|
nsIAtom* aAttribute, \
|
|
PRInt32 aModType) \
|
|
{ \
|
|
} \
|
|
void \
|
|
_class::ContentAppended(nsIDocument* aDocument, \
|
|
nsIContent* aContainer, \
|
|
PRInt32 aNewIndexInContainer) \
|
|
{ \
|
|
} \
|
|
void \
|
|
_class::ContentInserted(nsIDocument* aDocument, \
|
|
nsIContent* aContainer, \
|
|
nsIContent* aChild, \
|
|
PRInt32 aIndexInContainer) \
|
|
{ \
|
|
} \
|
|
void \
|
|
_class::ContentRemoved(nsIDocument* aDocument, \
|
|
nsIContent* aContainer, \
|
|
nsIContent* aChild, \
|
|
PRInt32 aIndexInContainer) \
|
|
{ \
|
|
}
|
|
|
|
#define NS_IMPL_NSIDOCUMENTOBSERVER_STYLE_STUB(_class) \
|
|
void \
|
|
_class::StyleSheetAdded(nsIDocument* aDocument, \
|
|
nsIStyleSheet* aStyleSheet, \
|
|
PRBool aDocumentSheet) \
|
|
{ \
|
|
} \
|
|
void \
|
|
_class::StyleSheetRemoved(nsIDocument* aDocument, \
|
|
nsIStyleSheet* aStyleSheet, \
|
|
PRBool aDocumentSheet) \
|
|
{ \
|
|
} \
|
|
void \
|
|
_class::StyleSheetApplicableStateChanged(nsIDocument* aDocument, \
|
|
nsIStyleSheet* aStyleSheet, \
|
|
PRBool aApplicable) \
|
|
{ \
|
|
} \
|
|
void \
|
|
_class::StyleRuleChanged(nsIDocument* aDocument, \
|
|
nsIStyleSheet* aStyleSheet, \
|
|
nsIStyleRule* aOldStyleRule, \
|
|
nsIStyleRule* aNewStyleRule) \
|
|
{ \
|
|
} \
|
|
void \
|
|
_class::StyleRuleAdded(nsIDocument* aDocument, \
|
|
nsIStyleSheet* aStyleSheet, \
|
|
nsIStyleRule* aStyleRule) \
|
|
{ \
|
|
} \
|
|
void \
|
|
_class::StyleRuleRemoved(nsIDocument* aDocument, \
|
|
nsIStyleSheet* aStyleSheet, \
|
|
nsIStyleRule* aStyleRule) \
|
|
{ \
|
|
}
|
|
|
|
#endif /* nsIDocumentObserver_h___ */
|