1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef _SDR_OVERLAY_OVERLAYOBJECTLIST_HXX
25 #define _SDR_OVERLAY_OVERLAYOBJECTLIST_HXX
26 
27 #include <svx/sdr/overlay/overlayobject.hxx>
28 #include <tools/gen.hxx>
29 #include "svx/svxdllapi.h"
30 
31 //////////////////////////////////////////////////////////////////////////////
32 
33 #define	DEFAULT_VALUE_FOR_HITTEST_PIXEL			(2L)
34 
35 //////////////////////////////////////////////////////////////////////////////
36 
37 namespace sdr
38 {
39 	namespace overlay
40 	{
41 		class SVX_DLLPUBLIC OverlayObjectList
42 		{
43 		protected:
44 			// the vector of OverlayObjects
45 			OverlayObjectVector						maVector;
46 
47 			// default value for HiTestPixel
getDefaultValueForHitTestPixel() const48 			sal_uInt32 getDefaultValueForHitTestPixel() const { return 4L; }
49 
50 		public:
OverlayObjectList()51 			OverlayObjectList() {}
52 			~OverlayObjectList();
53 
54 			// clear list, this includes deletion of all contained objects
55 			void clear();
56 
57 			// append/remove objects
append(OverlayObject & rOverlayObject)58 			void append(OverlayObject& rOverlayObject) { maVector.push_back(&rOverlayObject); }
59 			void remove(OverlayObject& rOverlayObject);
60 
61 			// access to objects
count() const62 			sal_uInt32 count() const { return maVector.size(); }
getOverlayObject(sal_uInt32 nIndex) const63 			OverlayObject& getOverlayObject(sal_uInt32 nIndex) const { return *(maVector[nIndex]); }
64 
65 			// Hittest with logical coordinates
66 			bool isHitLogic(const basegfx::B2DPoint& rLogicPosition, double fLogicTolerance = 0.0) const;
67 
68 			// Hittest with pixel coordinates and pixel tolerance
69 			bool isHitPixel(const Point& rDiscretePosition, sal_uInt32 fDiscreteTolerance = DEFAULT_VALUE_FOR_HITTEST_PIXEL) const;
70 
71 			// calculate BaseRange of all included OverlayObjects and return
72 			basegfx::B2DRange getBaseRange() const;
73 		};
74 	} // end of namespace overlay
75 } // end of namespace sdr
76 
77 //////////////////////////////////////////////////////////////////////////////
78 
79 #endif //_SDR_OVERLAY_OVERLAYOBJECTLIST_HXX
80 
81 // eof
82