xref: /aoo42x/main/sd/inc/shapelist.hxx (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef _SHAPELIST_HXX
29*cdf0e10cSrcweir #define _SHAPELIST_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <svx/sdrobjectuser.hxx>
32*cdf0e10cSrcweir 
33*cdf0e10cSrcweir #include <list>
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir namespace sd
36*cdf0e10cSrcweir {
37*cdf0e10cSrcweir 	class ShapeList : public sdr::ObjectUser
38*cdf0e10cSrcweir 	{
39*cdf0e10cSrcweir 	public:
40*cdf0e10cSrcweir 		ShapeList();
41*cdf0e10cSrcweir 		virtual ~ShapeList();
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir 		/** adds the given shape to this list */
44*cdf0e10cSrcweir 		void addShape( SdrObject& rObject );
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir 		/** removes the shape from this list and returns
47*cdf0e10cSrcweir 			a pointer to the next shape in list or 0*/
48*cdf0e10cSrcweir 		SdrObject* removeShape( SdrObject& rObject );
49*cdf0e10cSrcweir 
50*cdf0e10cSrcweir 		/** removes all shapes from this list */
51*cdf0e10cSrcweir 		void clear();
52*cdf0e10cSrcweir 
53*cdf0e10cSrcweir 		/** returns true if this list is empty */
54*cdf0e10cSrcweir 		bool isEmpty() const;
55*cdf0e10cSrcweir 
56*cdf0e10cSrcweir 		/** returns true if given shape is part of this list */
57*cdf0e10cSrcweir 		bool hasShape( SdrObject& rObject ) const;
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir 		/** returns the shape following the given shape in the list or 0
60*cdf0e10cSrcweir 			returns the first shape if pObj is 0 */
61*cdf0e10cSrcweir 		SdrObject* getNextShape(SdrObject* pObj) const;
62*cdf0e10cSrcweir 
63*cdf0e10cSrcweir 		/**
64*cdf0e10cSrcweir 		*/
65*cdf0e10cSrcweir 		SdrObject* getNextShape();
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir 		/**
68*cdf0e10cSrcweir 		*/
69*cdf0e10cSrcweir 		void seekShape( sal_uInt32 nIndex );
70*cdf0e10cSrcweir 
71*cdf0e10cSrcweir 		/**
72*cdf0e10cSrcweir 		*/
73*cdf0e10cSrcweir 		bool hasMore() const;
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir         const std::list< SdrObject* >& getList() const { return maShapeList; }
76*cdf0e10cSrcweir 
77*cdf0e10cSrcweir 	private:
78*cdf0e10cSrcweir 		virtual void ObjectInDestruction(const SdrObject& rObject);
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir 		typedef std::list< SdrObject* > ListImpl;
81*cdf0e10cSrcweir 		ListImpl maShapeList;
82*cdf0e10cSrcweir 		ListImpl::iterator maIter;
83*cdf0e10cSrcweir 	};
84*cdf0e10cSrcweir }
85*cdf0e10cSrcweir 
86*cdf0e10cSrcweir #endif	   // _SHAPELIST_HXX
87