diff options
Diffstat (limited to 'dom/base/nsIDocumentObserver.h')
| -rw-r--r-- | dom/base/nsIDocumentObserver.h | 291 |
1 files changed, 291 insertions, 0 deletions
diff --git a/dom/base/nsIDocumentObserver.h b/dom/base/nsIDocumentObserver.h new file mode 100644 index 000000000..ba73dd8cd --- /dev/null +++ b/dom/base/nsIDocumentObserver.h @@ -0,0 +1,291 @@ +/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim: set ts=8 sts=2 et sw=2 tw=80: */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ +#ifndef nsIDocumentObserver_h___ +#define nsIDocumentObserver_h___ + +#include "mozilla/EventStates.h" +#include "mozilla/StyleSheet.h" +#include "nsISupports.h" +#include "nsIMutationObserver.h" + +class nsIContent; +class nsIDocument; + +namespace mozilla { +namespace css { +class Rule; +} // namespace css +} // namespace mozilla + +#define NS_IDOCUMENT_OBSERVER_IID \ +{ 0x71041fa3, 0x6dd7, 0x4cde, \ + { 0xbb, 0x76, 0xae, 0xcc, 0x69, 0xe1, 0x75, 0x78 } } + +typedef uint32_t nsUpdateType; + +#define UPDATE_CONTENT_MODEL 0x00000001 +#define UPDATE_STYLE 0x00000002 +#define UPDATE_ALL (UPDATE_CONTENT_MODEL | UPDATE_STYLE) + +// Document observer interface +class nsIDocumentObserver : public nsIMutationObserver +{ +public: + NS_DECLARE_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; + + /** + * 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). + * + * @param aDocument The document being observed + * @param aContent the piece of content that changed + */ + virtual void ContentStateChanged(nsIDocument* aDocument, + nsIContent* aContent, + mozilla::EventStates aStateMask) = 0; + + /** + * Notification that the state of the document has changed. + * + * @param aDocument The document being observed + * @param aStateMask the state that changed + */ + virtual void DocumentStatesChanged(nsIDocument* aDocument, + mozilla::EventStates aStateMask) = 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 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(mozilla::StyleSheet* aStyleSheet, + bool 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 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(mozilla::StyleSheet* aStyleSheet, + bool 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 aStyleSheet the StyleSheet that has changed state + */ + virtual void StyleSheetApplicableStateChanged(mozilla::StyleSheet* aStyleSheet) = 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. + * + * @param aStyleSheet the StyleSheet that contians the rule + */ + virtual void StyleRuleChanged(mozilla::StyleSheet* aStyleSheet) = 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 aStyleSheet the StyleSheet that has been modified + */ + virtual void StyleRuleAdded(mozilla::StyleSheet* aStyleSheet) = 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 aStyleSheet the StyleSheet that has been modified + */ + virtual void StyleRuleRemoved(mozilla::StyleSheet* aStyleSheet) = 0; +}; + +NS_DEFINE_STATIC_IID_ACCESSOR(nsIDocumentObserver, NS_IDOCUMENT_OBSERVER_IID) + +#define NS_DECL_NSIDOCUMENTOBSERVER_BEGINUPDATE \ + virtual void BeginUpdate(nsIDocument* aDocument, \ + nsUpdateType aUpdateType) override; + +#define NS_DECL_NSIDOCUMENTOBSERVER_ENDUPDATE \ + virtual void EndUpdate(nsIDocument* aDocument, nsUpdateType aUpdateType) override; + +#define NS_DECL_NSIDOCUMENTOBSERVER_BEGINLOAD \ + virtual void BeginLoad(nsIDocument* aDocument) override; + +#define NS_DECL_NSIDOCUMENTOBSERVER_ENDLOAD \ + virtual void EndLoad(nsIDocument* aDocument) override; + +#define NS_DECL_NSIDOCUMENTOBSERVER_CONTENTSTATECHANGED \ + virtual void ContentStateChanged(nsIDocument* aDocument, \ + nsIContent* aContent, \ + mozilla::EventStates aStateMask) override; + +#define NS_DECL_NSIDOCUMENTOBSERVER_DOCUMENTSTATESCHANGED \ + virtual void DocumentStatesChanged(nsIDocument* aDocument, \ + mozilla::EventStates aStateMask) override; + +#define NS_DECL_NSIDOCUMENTOBSERVER_STYLESHEETADDED \ + virtual void StyleSheetAdded(mozilla::StyleSheet* aStyleSheet, \ + bool aDocumentSheet) override; + +#define NS_DECL_NSIDOCUMENTOBSERVER_STYLESHEETREMOVED \ + virtual void StyleSheetRemoved(mozilla::StyleSheet* aStyleSheet, \ + bool aDocumentSheet) override; + +#define NS_DECL_NSIDOCUMENTOBSERVER_STYLESHEETAPPLICABLESTATECHANGED \ + virtual void StyleSheetApplicableStateChanged( \ + mozilla::StyleSheet* aStyleSheet) override; + +#define NS_DECL_NSIDOCUMENTOBSERVER_STYLERULECHANGED \ + virtual void StyleRuleChanged(mozilla::StyleSheet* aStyleSheet) override; + +#define NS_DECL_NSIDOCUMENTOBSERVER_STYLERULEADDED \ + virtual void StyleRuleAdded(mozilla::StyleSheet* aStyleSheet) override; + +#define NS_DECL_NSIDOCUMENTOBSERVER_STYLERULEREMOVED \ + virtual void StyleRuleRemoved(mozilla::StyleSheet* aStyleSheet) override; + +#define NS_DECL_NSIDOCUMENTOBSERVER \ + NS_DECL_NSIDOCUMENTOBSERVER_BEGINUPDATE \ + NS_DECL_NSIDOCUMENTOBSERVER_ENDUPDATE \ + NS_DECL_NSIDOCUMENTOBSERVER_BEGINLOAD \ + NS_DECL_NSIDOCUMENTOBSERVER_ENDLOAD \ + NS_DECL_NSIDOCUMENTOBSERVER_CONTENTSTATECHANGED \ + NS_DECL_NSIDOCUMENTOBSERVER_DOCUMENTSTATESCHANGED \ + NS_DECL_NSIDOCUMENTOBSERVER_STYLESHEETADDED \ + NS_DECL_NSIDOCUMENTOBSERVER_STYLESHEETREMOVED \ + NS_DECL_NSIDOCUMENTOBSERVER_STYLESHEETAPPLICABLESTATECHANGED \ + NS_DECL_NSIDOCUMENTOBSERVER_STYLERULECHANGED \ + NS_DECL_NSIDOCUMENTOBSERVER_STYLERULEADDED \ + NS_DECL_NSIDOCUMENTOBSERVER_STYLERULEREMOVED \ + NS_DECL_NSIMUTATIONOBSERVER + + +#define NS_IMPL_NSIDOCUMENTOBSERVER_CORE_STUB(_class) \ +void \ +_class::BeginUpdate(nsIDocument* aDocument, nsUpdateType aUpdateType) \ +{ \ +} \ +void \ +_class::EndUpdate(nsIDocument* aDocument, nsUpdateType aUpdateType) \ +{ \ +} \ +NS_IMPL_NSIMUTATIONOBSERVER_CORE_STUB(_class) + +#define NS_IMPL_NSIDOCUMENTOBSERVER_LOAD_STUB(_class) \ +void \ +_class::BeginLoad(nsIDocument* aDocument) \ +{ \ +} \ +void \ +_class::EndLoad(nsIDocument* aDocument) \ +{ \ +} + +#define NS_IMPL_NSIDOCUMENTOBSERVER_STATE_STUB(_class) \ +void \ +_class::ContentStateChanged(nsIDocument* aDocument, \ + nsIContent* aContent, \ + mozilla::EventStates aStateMask) \ +{ \ +} \ + \ +void \ +_class::DocumentStatesChanged(nsIDocument* aDocument, \ + mozilla::EventStates aStateMask) \ +{ \ +} + +#define NS_IMPL_NSIDOCUMENTOBSERVER_CONTENT(_class) \ +NS_IMPL_NSIMUTATIONOBSERVER_CONTENT(_class) + +#define NS_IMPL_NSIDOCUMENTOBSERVER_STYLE_STUB(_class) \ +void \ +_class::StyleSheetAdded(mozilla::StyleSheet* aStyleSheet, \ + bool aDocumentSheet) \ +{ \ +} \ +void \ +_class::StyleSheetRemoved(mozilla::StyleSheet* aStyleSheet, \ + bool aDocumentSheet) \ +{ \ +} \ +void \ +_class::StyleSheetApplicableStateChanged(mozilla::StyleSheet* aStyleSheet)\ +{ \ +} \ +void \ +_class::StyleRuleChanged(mozilla::StyleSheet* aStyleSheet) \ +{ \ +} \ +void \ +_class::StyleRuleAdded(mozilla::StyleSheet* aStyleSheet) \ +{ \ +} \ +void \ +_class::StyleRuleRemoved(mozilla::StyleSheet* aStyleSheet) \ +{ \ +} + +#endif /* nsIDocumentObserver_h___ */ |