editor/composer/src/nsComposeTxtSrvFilter.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998-1999
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef nsComposeTxtSrvFilter_h__
  39 #define nsComposeTxtSrvFilter_h__
  40
  41 #include "nsITextServicesFilter.h"
  42 #include "nsIAtom.h"
  43
  44 /**
  45  * This class implements a filter interface, that enables
  46  * those using it to skip over certain nodes when traversing content
  47  *
  48  * This filter is used to skip over various form control nodes and
  49  * mail's cite nodes
  50  */
  51 class nsComposeTxtSrvFilter : public nsITextServicesFilter
  52 {
  53 public:
  54   nsComposeTxtSrvFilter();
  55   virtual ~nsComposeTxtSrvFilter() {}
  56
  57   // nsISupports interface...
  58   NS_DECL_ISUPPORTS
  59
  60   // nsITextServicesFilter
  61   NS_DECL_NSITEXTSERVICESFILTER
  62
  63   // Helper - Intializer
  64   void Init(PRBool aIsForMail) { mIsForMail = aIsForMail; }
  65
  66 protected:
  67   PRBool            mIsForMail;
  68   nsCOMPtr<nsIAtom> mBlockQuoteAtom;
  69   nsCOMPtr<nsIAtom> mPreAtom;          // mail plain text quotes are wrapped in pre tags
  70   nsCOMPtr<nsIAtom> mSpanAtom;         //or they may be wrapped in span tags (editor.quotesPreformatted).
  71   nsCOMPtr<nsIAtom> mMozQuoteAtom;     // _moz_quote_
  72   nsCOMPtr<nsIAtom> mTableAtom;
  73   nsCOMPtr<nsIAtom> mClassAtom;
  74   nsCOMPtr<nsIAtom> mTypeAtom;
  75   nsCOMPtr<nsIAtom> mScriptAtom;
  76   nsCOMPtr<nsIAtom> mTextAreaAtom;
  77   nsCOMPtr<nsIAtom> mSelectAreaAtom;
  78   nsCOMPtr<nsIAtom> mMapAtom;
  79   nsCOMPtr<nsIAtom> mCiteAtom;
  80   nsCOMPtr<nsIAtom> mTrueAtom;
  81   nsCOMPtr<nsIAtom> mMozSignatureAtom;
  82 };
  83
  84 #define NS_COMPOSERTXTSRVFILTER_CID \
  85 {/* {171E72DB-0F8A-412a-8461-E4C927A3A2AC}*/ \
  86 0x171e72db, 0xf8a, 0x412a, \
  87 { 0x84, 0x61, 0xe4, 0xc9, 0x27, 0xa3, 0xa2, 0xac} }
  88
  89 #define NS_COMPOSERTXTSRVFILTERMAIL_CID \
  90 {/* {7FBD2146-5FF4-4674-B069-A7BBCE66E773}*/ \
  91 0x7fbd2146, 0x5ff4, 0x4674, \
  92 { 0xb0, 0x69, 0xa7, 0xbb, 0xce, 0x66, 0xe7, 0x73} }
  93
  94 // Generic for the editor
  95 #define COMPOSER_TXTSRVFILTER_CONTRACTID     "@mozilla.org/editor/txtsrvfilter;1"
  96
  97 // This is the same but includes "cite" typed blocked quotes
  98 #define COMPOSER_TXTSRVFILTERMAIL_CONTRACTID "@mozilla.org/editor/txtsrvfiltermail;1"
  99
 100 #endif