sw/source/core/access/accfrmobjslist.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: accfrmobjslist.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _ACCFRMOBJSLIST_HXX
  31 #define _ACCFRMOBJSLIST_HXX
  32
  33 #include <accfrmobj.hxx>
  34
  35 class SwFrmOrObjSList;
  36
  37 class SwFrmOrObjSList_const_iterator
  38 {
  39     friend class SwFrmOrObjSList;
  40     const SwFrmOrObjSList& rList;       // The frame we are iterating over
  41     SwFrmOrObj aCurr;                           // The current object
  42     sal_uInt16 nNextObj;                        // The index of the current sdr object
  43
  44     inline SwFrmOrObjSList_const_iterator( const SwFrmOrObjSList& rLst );
  45     SwFrmOrObjSList_const_iterator( const SwFrmOrObjSList& rLst, sal_Bool );
  46
  47 //      SwFrmOrObjSList_const_iterator& begin();
  48     SwFrmOrObjSList_const_iterator& next();
  49     SwFrmOrObjSList_const_iterator& next_visible();
  50
  51 public:
  52
  53     inline SwFrmOrObjSList_const_iterator(
  54             const SwFrmOrObjSList_const_iterator& rIter );
  55     inline sal_Bool operator==(
  56             const SwFrmOrObjSList_const_iterator& r ) const;
  57     inline sal_Bool operator!=(
  58             const SwFrmOrObjSList_const_iterator& r ) const;
  59     inline SwFrmOrObjSList_const_iterator& operator++();
  60     inline const SwFrmOrObj& operator*() const;
  61 };
  62
  63 // An iterator to iterate over a frame's child in any order
  64 class SwFrmOrObjSList
  65 {
  66     friend class SwFrmOrObjSList_const_iterator;
  67
  68     SwRect aVisArea;
  69     const SwFrm *pFrm;  // The frame we are iterating over
  70     sal_Bool bVisibleOnly;
  71
  72 public:
  73
  74     typedef SwFrmOrObjSList_const_iterator const_iterator;
  75
  76     inline SwFrmOrObjSList( const SwFrm *pF );
  77     inline SwFrmOrObjSList( const SwRect& rVisArea, const SwFrm *pF );
  78
  79     inline const_iterator begin() const;
  80     inline const_iterator end() const;
  81 };
  82
  83 inline SwFrmOrObjSList_const_iterator::SwFrmOrObjSList_const_iterator(
  84         const SwFrmOrObjSList& rLst ) :
  85     rList( rLst ), nNextObj( 0 )
  86 {
  87 }
  88
  89 inline SwFrmOrObjSList_const_iterator::SwFrmOrObjSList_const_iterator(
  90         const SwFrmOrObjSList_const_iterator& rIter ) :
  91     rList( rIter.rList ),
  92     aCurr( rIter.aCurr ),
  93     nNextObj( rIter.nNextObj )
  94 {
  95 }
  96
  97 inline sal_Bool SwFrmOrObjSList_const_iterator::operator==(
  98     const SwFrmOrObjSList_const_iterator& r ) const
  99 {
 100     return aCurr == r.aCurr;
 101 }
 102
 103 inline sal_Bool SwFrmOrObjSList_const_iterator::operator!=(
 104     const SwFrmOrObjSList_const_iterator& r ) const
 105 {
 106     return !(aCurr == r.aCurr);
 107 }
 108
 109 inline SwFrmOrObjSList_const_iterator& SwFrmOrObjSList_const_iterator::operator++()
 110 {
 111     return rList.bVisibleOnly ? next_visible() : next();
 112 }
 113
 114 inline const SwFrmOrObj& SwFrmOrObjSList_const_iterator::operator*() const
 115 {
 116     return aCurr;
 117 }
 118
 119 inline SwFrmOrObjSList::SwFrmOrObjSList( const SwFrm *pF ) :
 120     pFrm( pF ),
 121     bVisibleOnly( sal_False )
 122 {
 123 }
 124
 125 inline SwFrmOrObjSList::SwFrmOrObjSList( const SwRect& rVisArea,
 126                                              const SwFrm *pF ) :
 127     aVisArea( rVisArea ),
 128     pFrm( pF )
 129 {
 130     SwFrmOrObj aFrm( pFrm );
 131     bVisibleOnly = aFrm.IsVisibleChildrenOnly();
 132 }
 133
 134 inline SwFrmOrObjSList_const_iterator SwFrmOrObjSList::begin() const
 135 {
 136 //      SwFrmOrObjSList_const_iterator aIter2( *this );
 137 //      aIter2.begin();
 138 //      return aIter2;
 139     return SwFrmOrObjSList_const_iterator( *this, sal_True );
 140 }
 141
 142 inline SwFrmOrObjSList_const_iterator SwFrmOrObjSList::end() const
 143 {
 144     return SwFrmOrObjSList_const_iterator( *this );
 145 }
 146
 147 #endif