office-gobmx/sd/source/ui/toolpanel/ConstrainedIterator.hxx
Rüdiger Timm 9ef89bcf91 INTEGRATION: CWS impress2 (1.1.2); FILE ADDED
2004/03/02 11:04:10 af 1.1.2.1: #i22705# Initial revision.
2004-07-13 13:30:24 +00:00

138 lines
4.5 KiB
C++

/*************************************************************************
*
* $RCSfile: ConstrainedIterator.hxx,v $
*
* $Revision: 1.2 $
*
* last change: $Author: rt $ $Date: 2004-07-13 14:30:24 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef SD_TOOLPANEL_CONSTRAINED_ITERATOR_HXX
#define SD_TOOLPANEL_CONSTRAINED_ITERATOR_HXX
#include <iterator>
namespace sd { namespace toolpanel {
template <class Container>
class Constraint
{
public:
virtual bool operator() (
const Container& rContainer,
const Container::iterator& rIterator) const = 0;
};
/** This iterator is a bidirectional iterator with something of random
access thrown in. It uses a constraint object to jump over
elements in the underlying container that do not meet the
constraint.
*/
template <class Container>
class ConstrainedIterator
: public ::std::bidirectional_iterator_tag
{
public:
typedef Container::value_type value_type;
typedef value_type& reference;
typedef const value_type& const_reference;
ConstrainedIterator (void);
ConstrainedIterator (
const Container& rContainer,
const Container::iterator& rIterator);
ConstrainedIterator (
const Container& rContainer,
const Container::iterator& rIterator,
const Constraint<Container>& pConstraint);
ConstrainedIterator (
const ConstrainedIterator& rIterator);
ConstrainedIterator& operator= (
const ConstrainedIterator& aIterator);
reference operator* (void);
const_reference operator* (void) const;
reference operator-> (void);
const_reference operator-> (void) const;
bool operator== (const ConstrainedIterator& aIterator) const;
bool operator!= (const ConstrainedIterator& aIterator) const;
ConstrainedIterator& operator++ (void);
ConstrainedIterator operator++ (int);
ConstrainedIterator& operator-- (void);
ConstrainedIterator operator-- (int);
ConstrainedIterator operator+ (int nValue) const;
ConstrainedIterator operator- (int nValue) const;
private:
const Container* mpContainer;
Container::iterator maIterator;
const Constraint<Container>* mpConstraint;
void AdvanceToNextValidElement (void);
void AdvanceToPreviousValidElement (void);
};
} } // end of namespace ::sd::toolpanel
#endif