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