LCOV - app.info - objdir/dist/include/nsIContentIterator.h

LCOV - code coverage report
| Current view: | directory - objdir/dist/include - nsIContentIterator.h (source / functions) |  | Found | Hit | Coverage |
| Test: | app.info | Lines: | 1 | 1 | 100.0 %
| Date: | 2012-04-21 | Functions: | 1 | 1 | 100.0 %

           1                 : /* -*- Mode: C++; tab-width: 4; 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
          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 __nsIContentIterator_h___
          39                 : #define __nsIContentIterator_h___
          40                 :
          41                 : #include "nsISupports.h"
          42                 :
          43                 : class nsINode;
          44                 : class nsIDOMRange;
          45                 :
          46                 : #define NS_ICONTENTITERATOR_IID \
          47                 : { 0x2550078e, 0xae87, 0x4914, \
          48                 :  { 0xb3, 0x04, 0xe4, 0xd1, 0x46, 0x19, 0x3d, 0x5f } }
          49                 :
          50                 : class nsIContentIterator : public nsISupports
          51               6 : {
          52                 : public:
          53                 :   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ICONTENTITERATOR_IID)
          54                 :
          55                 :   /* Initializes an iterator for the subtree rooted by the node aRoot
          56                 :    */
          57                 :   virtual nsresult Init(nsINode* aRoot) = 0;
          58                 :
          59                 :   /* Initializes an iterator for the subtree defined by the range aRange
          60                 :      Subclasses should make sure they implement both of these!
          61                 :    */
          62                 :   virtual nsresult Init(nsIDOMRange* aRange) = 0;
          63                 :
          64                 :   /** First will reset the list.
          65                 :    */
          66                 :   virtual void First() = 0;
          67                 :
          68                 :   /** Last will reset the list to the end.
          69                 :    */
          70                 :   virtual void Last() = 0;
          71                 :
          72                 :   /** Next will advance the list.
          73                 :    */
          74                 :   virtual void Next() = 0;
          75                 :
          76                 :   /** Prev will decrement the list.
          77                 :    */
          78                 :   virtual void Prev() = 0;
          79                 :
          80                 :   /** CurrentItem will return the current item, or null if the list is empty
          81                 :    *  @return the current node
          82                 :    */
          83                 :   virtual nsINode *GetCurrentNode() = 0;
          84                 :
          85                 :   /** return if the collection is at the end. that is the beginning following a call to Prev
          86                 :    *  and it is the end of the list following a call to next
          87                 :    *  @return if the iterator is done.
          88                 :    */
          89                 :   virtual bool IsDone() = 0;
          90                 :
          91                 :   /** PositionAt will position the iterator to the supplied node
          92                 :    */
          93                 :   virtual nsresult PositionAt(nsINode* aCurNode) = 0;
          94                 : };
          95                 :
          96                 : NS_DEFINE_STATIC_IID_ACCESSOR(nsIContentIterator, NS_ICONTENTITERATOR_IID)
          97                 :
          98                 : #endif // __nsIContentIterator_h___
          99                 :

Generated by: LCOV version 1.7