Back to index

lightning-sunbird  0.9+nobinonly
nsFilteredContentIterator.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998-1999
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsFilteredContentIterator_h__
00039 #define nsFilteredContentIterator_h__
00040 
00041 #include "nsIContentIterator.h"
00042 #include "nsCOMPtr.h"
00043 #include "nsIAtom.h"
00044 #include "nsITextServicesFilter.h"
00045 #include "nsIDOMNSRange.h"
00046 #include "nsIRangeUtils.h"
00047 
00051 class nsFilteredContentIterator : public nsIContentIterator
00052 {
00053 public:
00054 
00055   // nsISupports interface...
00056   NS_DECL_ISUPPORTS
00057 
00058   nsFilteredContentIterator(nsITextServicesFilter* aFilter);
00059 
00060   virtual ~nsFilteredContentIterator();
00061 
00062   /* nsIContentIterator */
00063   virtual nsresult Init(nsIContent* aRoot);
00064   virtual nsresult Init(nsIDOMRange* aRange);
00065   virtual void First();
00066   virtual void Last();
00067   virtual void Next();
00068   virtual void Prev();
00069   virtual nsIContent *GetCurrentNode();
00070   virtual PRBool IsDone();
00071   virtual nsresult PositionAt(nsIContent* aCurNode);
00072 
00073   /* Helpers */
00074   PRPackedBool DidSkip()      { return mDidSkip; }
00075   void         ClearDidSkip() {  mDidSkip = PR_FALSE; }
00076 
00077 protected:
00078   nsFilteredContentIterator() { }
00079 
00080   // enum to give us the direction
00081   typedef enum {eDirNotSet, eForward, eBackward} eDirectionType;
00082   nsresult AdvanceNode(nsIDOMNode* aNode, nsIDOMNode*& aNewNode, eDirectionType aDir);
00083   void CheckAdvNode(nsIDOMNode* aNode, PRPackedBool& aDidSkip, eDirectionType aDir);
00084   nsresult SwitchDirections(PRPackedBool aChangeToForward);
00085 
00086   nsCOMPtr<nsIContentIterator> mCurrentIterator;
00087   nsCOMPtr<nsIContentIterator> mIterator;
00088   nsCOMPtr<nsIContentIterator> mPreIterator;
00089 
00090   nsCOMPtr<nsIAtom> mBlockQuoteAtom;
00091   nsCOMPtr<nsIAtom> mScriptAtom;
00092   nsCOMPtr<nsIAtom> mTextAreaAtom;
00093   nsCOMPtr<nsIAtom> mSelectAreaAtom;
00094   nsCOMPtr<nsIAtom> mMapAtom;
00095 
00096   nsCOMPtr<nsITextServicesFilter> mFilter;
00097   nsCOMPtr<nsIDOMNSRange>         mRange;
00098   PRPackedBool                    mDidSkip;
00099   PRPackedBool                    mIsOutOfRange;
00100   eDirectionType                  mDirection;
00101 };
00102 
00103 #endif