office-gobmx/sd/source/ui/toolpanel/ConstrainedIterator.hxx
Rüdiger Timm 5eb90d854b INTEGRATION: CWS changefileheader (1.3.624); FILE MERGED
2008/03/31 13:58:57 rt 1.3.624.1: #i87441# Change license header to LPGL v3.
2008-04-10 21:21:28 +00:00

107 lines
3.2 KiB
C++

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: ConstrainedIterator.hxx,v $
* $Revision: 1.4 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#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