include/svx/sdr/overlay/overlayobjectlist.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 _SDR_OVERLAY_OVERLAYOBJECTLIST_HXX
  21 #define _SDR_OVERLAY_OVERLAYOBJECTLIST_HXX
  22
  23 #include <svx/sdr/overlay/overlayobject.hxx>
  24 #include <sal/types.h>
  25 #include "svx/svxdllapi.h"
  26
  27 //////////////////////////////////////////////////////////////////////////////
  28
  29 #define DEFAULT_VALUE_FOR_HITTEST_PIXEL         (2L)
  30
  31 //////////////////////////////////////////////////////////////////////////////
  32
  33 class Point;
  34
  35 namespace sdr
  36 {
  37     namespace overlay
  38     {
  39         class SVX_DLLPUBLIC OverlayObjectList
  40         {
  41         protected:
  42             // the vector of OverlayObjects
  43             OverlayObjectVector                     maVector;
  44
  45             // default value for HiTestPixel
  46             sal_uInt32 getDefaultValueForHitTestPixel() const { return 4L; }
  47
  48         public:
  49             OverlayObjectList() {}
  50             ~OverlayObjectList();
  51
  52             // clear list, this includes deletion of all contained objects
  53             void clear();
  54
  55             // append objects
  56             void append(OverlayObject& rOverlayObject) { maVector.push_back(&rOverlayObject); }
  57
  58             // access to objects
  59             sal_uInt32 count() const { return maVector.size(); }
  60             OverlayObject& getOverlayObject(sal_uInt32 nIndex) const { return *(maVector[nIndex]); }
  61
  62             // Hittest with logical coordinates
  63             bool isHitLogic(const basegfx::B2DPoint& rLogicPosition, double fLogicTolerance = 0.0) const;
  64
  65             // Hittest with pixel coordinates and pixel tolerance
  66             bool isHitPixel(const Point& rDiscretePosition, sal_uInt32 fDiscreteTolerance = DEFAULT_VALUE_FOR_HITTEST_PIXEL) const;
  67
  68             // calculate BaseRange of all included OverlayObjects and return
  69             basegfx::B2DRange getBaseRange() const;
  70         };
  71     } // end of namespace overlay
  72 } // end of namespace sdr
  73
  74 //////////////////////////////////////////////////////////////////////////////
  75
  76 #endif //_SDR_OVERLAY_OVERLAYOBJECTLIST_HXX
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */