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