sd/inc/shapelist.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SD_INC_SHAPELIST_HXX
  21 #define INCLUDED_SD_INC_SHAPELIST_HXX
  22
  23 #include <svx/sdrobjectuser.hxx>
  24
  25 #include <list>
  26
  27 namespace sd
  28 {
  29     class ShapeList : public sdr::ObjectUser
  30     {
  31     public:
  32         ShapeList();
  33         virtual ~ShapeList();
  34
  35         /** adds the given shape to this list */
  36         void addShape( SdrObject& rObject );
  37
  38         /** removes the shape from this list and returns
  39             a pointer to the next shape in list or 0*/
  40         SdrObject* removeShape( SdrObject& rObject );
  41
  42         /** removes all shapes from this list */
  43         void clear();
  44
  45         /** @return true if this list is empty */
  46         bool isEmpty() const;
  47
  48         /** @return true if given shape is part of this list */
  49         bool hasShape( SdrObject& rObject ) const;
  50
  51         /** returns the shape the internal iterator points to, or 0 if
  52          * the list end is reached. moves the internal iterator to the
  53          * next shape. */
  54         SdrObject* getNextShape();
  55
  56         /** Sets the internal iterator to the shape at given index. */
  57         void seekShape( sal_uInt32 nIndex );
  58
  59         /**
  60         */
  61         bool hasMore() const;
  62
  63         const std::list< SdrObject* >& getList() const { return maShapeList; }
  64
  65     private:
  66         virtual void ObjectInDestruction(const SdrObject& rObject) SAL_OVERRIDE;
  67
  68         typedef std::list< SdrObject* > ListImpl;
  69         ListImpl maShapeList;
  70         ListImpl::iterator maIter;
  71     };
  72 }
  73
  74 #endif // INCLUDED_SD_INC_SHAPELIST_HXX
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */