sd/inc/shapelist.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: shapelist.hxx,v $
  10  * $Revision: 1.4 $
  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
  31 #ifndef _SHAPELIST_HXX
  32 #define _SHAPELIST_HXX
  33
  34 #include <svx/sdrobjectuser.hxx>
  35
  36 #include <list>
  37
  38 namespace sd
  39 {
  40     class ShapeList : public sdr::ObjectUser
  41     {
  42     public:
  43         ShapeList();
  44         virtual ~ShapeList();
  45
  46         /** adds the given shape to this list */
  47         void addShape( SdrObject& rObject );
  48
  49         /** removes the shape from this list and returns
  50             a pointer to the next shape in list or 0*/
  51         SdrObject* removeShape( SdrObject& rObject );
  52
  53         /** removes all shapes from this list */
  54         void clear();
  55
  56         /** returns true if this list is empty */
  57         bool isEmpty() const;
  58
  59         /** returns true if given shape is part of this list */
  60         bool hasShape( SdrObject& rObject ) const;
  61
  62         /** returns the shape following the given shape in the list or 0
  63             returns the first shape if pObj is 0 */
  64         SdrObject* getNextShape(SdrObject* pObj) const;
  65
  66         /** returns the shape prior to the given shape in the list or 0
  67             returns the last shape if pObj is 0 */
  68         SdrObject* getPreviousShape( SdrObject* pObj ) const;
  69
  70         /**
  71         */
  72         SdrObject* getNextShape();
  73
  74         /**
  75         */
  76         void seekShape( sal_uInt32 nIndex );
  77
  78         /**
  79         */
  80         bool hasMore() const;
  81
  82     private:
  83         virtual void ObjectInDestruction(const SdrObject& rObject);
  84
  85         typedef std::list< SdrObject* > ListImpl;
  86         ListImpl maShapeList;
  87         ListImpl::iterator maIter;
  88     };
  89 }
  90
  91 #endif     // _SHAPELIST_HXX