LibreOffice Module sw (master)  1
swrect.hxx
Go to the documentation of this file.
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 #ifndef INCLUDED_SW_INC_SWRECT_HXX
20 #define INCLUDED_SW_INC_SWRECT_HXX
21 
22 #include <ostream>
23 
24 #include <sal/log.hxx>
25 #include <tools/gen.hxx>
26 #include "swdllapi.h"
27 
28 class SvStream;
29 typedef struct _xmlTextWriter* xmlTextWriterPtr;
30 
36 {
39 
40 public:
41  inline SwRect();
42  inline SwRect( const SwRect &rRect );
43  inline SwRect( const Point& rLT, const Size& rSize );
44  inline SwRect( const Point& rLT, const Point& rRB );
45  inline SwRect( tools::Long X, tools::Long Y, tools::Long Width, tools::Long Height );
46 
47  //SV-SS e.g. SwRect( pWin->GetClipRect() );
48  SwRect( const tools::Rectangle &rRect );
49 
50  //Set-Methods
51  inline void Chg( const Point& rNP, const Size &rNS );
52  inline void Pos( const Point& rNew );
53  inline void Pos( const tools::Long nNewX, const tools::Long nNewY );
54  inline void SSize( const Size& rNew );
55  inline void SSize( const tools::Long nHeight, const tools::Long nWidth );
56  inline void Width( tools::Long nNew );
57  inline void Height( tools::Long nNew );
58  inline void Left( const tools::Long nLeft );
59  inline void Right( const tools::Long nRight );
60  inline void Top( const tools::Long nTop );
61  inline void Bottom( const tools::Long nBottom );
62 
63  //Get-Methods
64  inline const Point &Pos() const;
65  inline const Size &SSize() const;
66  inline tools::Long Width() const;
67  inline tools::Long Height() const;
68  inline tools::Long Left() const;
69  inline tools::Long Right() const;
70  inline tools::Long Top() const;
71  inline tools::Long Bottom() const;
72 
73  // In order to be able to access the members of Pos and SSize from the layout side.
74  inline Point &Pos();
75 
76  Point Center() const;
77 
78  void Justify();
79 
80  SwRect &Union( const SwRect& rRect );
81  SwRect &Intersection( const SwRect& rRect );
82 
83  // Same as Intersection, only assume that Rects are overlapping!
84  SwRect &Intersection_( const SwRect &rRect );
85 
86  bool IsInside( const Point& rPOINT ) const;
87  bool IsNear(const Point& rPoint, tools::Long nTolerance ) const;
88  bool IsInside( const SwRect& rRect ) const;
89  bool IsOver( const SwRect& rRect ) const;
90  inline bool HasArea() const;
91  inline bool IsEmpty() const;
92  inline void Clear();
93 
94  inline SwRect &operator = ( const SwRect &rRect );
95 
96  inline bool operator == ( const SwRect& rRect ) const;
97  inline bool operator != ( const SwRect& rRect ) const;
98 
99  inline SwRect &operator+=( const Point &rPt );
100  inline SwRect &operator-=( const Point &rPt );
101 
102  //SV-SS e.g. pWin->DrawRect( aSwRect.SVRect() );
103  inline tools::Rectangle SVRect() const;
104 
105  // Output operator for debugging.
106  friend SvStream& WriteSwRect( SvStream &rStream, const SwRect &rRect );
107  void dumpAsXmlAttributes(xmlTextWriterPtr writer) const;
108 
109  void Top_( const tools::Long nTop );
110  void Bottom_( const tools::Long nBottom );
111  void Left_( const tools::Long nLeft );
112  void Right_( const tools::Long nRight );
113  void Width_( const tools::Long nNew );
114  void Height_( const tools::Long nNew );
115  tools::Long Top_() const;
116  tools::Long Bottom_() const;
117  tools::Long Left_() const;
118  tools::Long Right_() const;
119  tools::Long Width_() const;
120  tools::Long Height_() const;
121  void SubTop( const tools::Long nSub );
122  void AddTop( const tools::Long nAdd );
123  void AddBottom( const tools::Long nAdd );
124  void AddLeft( const tools::Long nAdd );
125  void SubLeft( const tools::Long nSub );
126  void AddRight( const tools::Long nAdd );
127  void AddWidth( const tools::Long nAdd );
128  void AddHeight( const tools::Long nAdd );
129  void SetPosX( const tools::Long nNew );
130  void SetPosY( const tools::Long nNew );
131  void SetLeftAndWidth( tools::Long nLeft, tools::Long nNew );
132  void SetTopAndHeight( tools::Long nTop, tools::Long nNew );
133  void SetRightAndWidth( tools::Long nRight, tools::Long nNew );
134  void SetBottomAndHeight( tools::Long nBottom, tools::Long nNew );
135  void SetUpperLeftCorner( const Point& rNew );
136  void SetUpperRightCorner( const Point& rNew );
137  void SetLowerLeftCorner( const Point& rNew );
138  Size Size_() const;
139  Point TopLeft() const;
140  Point TopRight() const;
141  Point BottomLeft() const;
142  Point BottomRight() const;
143  Size SwappedSize() const;
144  tools::Long GetLeftDistance( tools::Long ) const;
145  tools::Long GetBottomDistance( tools::Long ) const;
146  tools::Long GetRightDistance( tools::Long ) const;
147  tools::Long GetTopDistance( tools::Long ) const;
148  bool OverStepLeft( tools::Long ) const;
149  bool OverStepBottom( tools::Long ) const;
150  bool OverStepTop( tools::Long ) const;
151  bool OverStepRight( tools::Long ) const;
152 };
153 
154 typedef void (SwRect::*SwRectSet)( const tools::Long nNew );
155 typedef long (SwRect::*SwRectGet)() const;
156 typedef Point (SwRect::*SwRectPoint)() const;
157 typedef Size (SwRect::*SwRectSize)() const;
158 typedef bool (SwRect::*SwRectMax)( tools::Long ) const;
159 typedef long (SwRect::*SwRectDist)( tools::Long ) const;
161 typedef void (SwRect::*SwRectSetPos)( const Point& );
162 
163 // Set-Methods
164 inline void SwRect::Chg( const Point& rNP, const Size &rNS )
165 {
166  m_Point = rNP;
167  m_Size = rNS;
168 }
169 inline void SwRect::Pos( const Point& rNew )
170 {
171  m_Point = rNew;
172 }
173 inline void SwRect::Pos( const tools::Long nNewX, const tools::Long nNewY )
174 {
175  m_Point.setX(nNewX);
176  m_Point.setY(nNewY);
177 }
178 inline void SwRect::SSize( const Size& rNew )
179 {
180  m_Size = rNew;
181 }
182 inline void SwRect::SSize( const tools::Long nNewHeight, const tools::Long nNewWidth )
183 {
184  m_Size.setWidth(nNewWidth);
185  m_Size.setHeight(nNewHeight);
186 }
187 inline void SwRect::Width( tools::Long nNew )
188 {
189  m_Size.setWidth(nNew);
190 }
191 inline void SwRect::Height( tools::Long nNew )
192 {
193  m_Size.setHeight(nNew);
194 }
195 inline void SwRect::Left( const tools::Long nLeft )
196 {
197  m_Size.AdjustWidth( m_Point.getX() - nLeft );
198  m_Point.setX(nLeft);
199 }
200 inline void SwRect::Right( const tools::Long nRight )
201 {
202  m_Size.setWidth(nRight - m_Point.getX() + 1);
203 }
204 inline void SwRect::Top( const tools::Long nTop )
205 {
206  m_Size.AdjustHeight( m_Point.getY() - nTop );
207  m_Point.setY(nTop);
208 }
209 inline void SwRect::Bottom( const tools::Long nBottom )
210 {
211  m_Size.setHeight(nBottom - m_Point.getY() + 1);
212 }
213 
214 // Get-Methods
215 inline const Point &SwRect::Pos() const
216 {
217  return m_Point;
218 }
220 {
221  return m_Point;
222 }
223 inline const Size &SwRect::SSize() const
224 {
225  return m_Size;
226 }
228 {
229  return m_Size.Width();
230 }
232 {
233  return m_Size.Height();
234 }
235 inline tools::Long SwRect::Left() const
236 {
237  return m_Point.X();
238 }
240 {
241  return m_Size.getWidth() ? m_Point.getX() + m_Size.getWidth() - 1 : m_Point.getX();
242 }
243 inline tools::Long SwRect::Top() const
244 {
245  return m_Point.Y();
246 }
248 {
249  return m_Size.getHeight() ? m_Point.getY() + m_Size.getHeight() - 1 : m_Point.getY();
250 }
251 
252 // operators
253 inline SwRect &SwRect::operator = ( const SwRect &rRect )
254 {
255  m_Point = rRect.m_Point;
256  m_Size = rRect.m_Size;
257  return *this;
258 }
259 inline bool SwRect::operator == ( const SwRect& rRect ) const
260 {
261  return (m_Point == rRect.m_Point && m_Size == rRect.m_Size);
262 }
263 inline bool SwRect::operator != ( const SwRect& rRect ) const
264 {
265  return (m_Point != rRect.m_Point || m_Size != rRect.m_Size);
266 }
267 
268 inline SwRect &SwRect::operator+=( const Point &rPt )
269 {
270  m_Point += rPt;
271  return *this;
272 }
273 inline SwRect &SwRect::operator-=( const Point &rPt )
274 {
275  m_Point -= rPt;
276  return *this;
277 }
278 
279 // other
281 {
282  SAL_WARN_IF( IsEmpty(), "sw", "SVRect() without Width or Height" );
283  return tools::Rectangle( m_Point.getX(), m_Point.getY(),
284  m_Point.getX() + m_Size.getWidth() - 1, //Right()
285  m_Point.getY() + m_Size.getHeight() - 1 ); //Bottom()
286 }
287 
288 inline bool SwRect::HasArea() const
289 {
290  return !IsEmpty();
291 }
292 inline bool SwRect::IsEmpty() const
293 {
294  return !(m_Size.getHeight() && m_Size.getWidth());
295 }
296 inline void SwRect::Clear()
297 {
298  m_Point.setX(0);
299  m_Point.setY(0);
300  m_Size.setWidth(0);
301  m_Size.setHeight(0);
302 }
303 
304 // constructors
305 inline SwRect::SwRect() :
306  m_Point( 0, 0 ),
307  m_Size( 0, 0 )
308 {
309 }
310 inline SwRect::SwRect( const SwRect &rRect ) :
311  m_Point( rRect.m_Point ),
312  m_Size( rRect.m_Size )
313 {
314 }
315 inline SwRect::SwRect( const Point& rLT, const Size& rSize ) :
316  m_Point( rLT ),
317  m_Size( rSize )
318 {
319 }
320 inline SwRect::SwRect( const Point& rLT, const Point& rRB ) :
321  m_Point( rLT ),
322  m_Size( rRB.X() - rLT.X() + 1, rRB.Y() - rLT.Y() + 1 )
323 {
324 }
326  m_Point( X, Y ),
327  m_Size( W, H )
328 {
329 }
330 
331 template< typename charT, typename traits >
332 inline std::basic_ostream<charT, traits> & operator <<(
333  std::basic_ostream<charT, traits> & stream, const SwRect& rectangle )
334 {
335  if (rectangle.IsEmpty())
336  stream << "EMPTY:";
337  return stream << rectangle.SSize()
338  << "@(" << rectangle.Pos() << ")";
339 }
340 
341 #endif // INCLUDED_SW_INC_SWRECT_HXX
342 
343 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Size m_Size
Definition: swrect.hxx:38
bool(SwRect::* SwRectMax)(tools::Long) const
Definition: swrect.hxx:158
struct _xmlTextWriter * xmlTextWriterPtr
Definition: swrect.hxx:29
void setWidth(tools::Long nWidth)
tools::Long getWidth() const
long Long
tools::Long Right() const
Definition: swrect.hxx:239
timeval & operator-=(timeval &t1, const timeval &t2)
tools::Long Height() const
Definition: swrect.hxx:231
void Pos(const Point &rNew)
Definition: swrect.hxx:169
Of course Writer needs its own rectangles.
Definition: swrect.hxx:35
long(SwRect::* SwRectGet)() const
Definition: swrect.hxx:155
Center
tools::Long Bottom() const
Definition: swrect.hxx:247
#define X
bool IsEmpty() const
Definition: swrect.hxx:292
void(SwRect::* SwRectSet)(const tools::Long nNew)
Definition: swrect.hxx:154
tools::Long getHeight() const
struct _xmlTextWriter * xmlTextWriterPtr
Right
const Size & SSize() const
Definition: swrect.hxx:223
SwRect & operator=(const SwRect &rRect)
Definition: swrect.hxx:253
bool HasArea() const
Definition: swrect.hxx:288
tools::Long Width() const
#define SW_DLLPUBLIC
Definition: swdllapi.h:28
void SSize(const Size &rNew)
Definition: swrect.hxx:178
#define Y
void(SwRect::* SwRectSetTwice)(tools::Long, tools::Long)
Definition: swrect.hxx:160
#define SAL_WARN_UNUSED
SwRect & operator+=(const Point &rPt)
Definition: swrect.hxx:268
tools::Long Left() const
Definition: swrect.hxx:235
tools::Rectangle SVRect() const
Definition: swrect.hxx:280
Point m_Point
Definition: swrect.hxx:37
#define SAL_WARN_IF(condition, area, stream)
tools::Long Top() const
Definition: swrect.hxx:243
tools::Long AdjustWidth(tools::Long n)
tools::Long Height() const
long(SwRect::* SwRectDist)(tools::Long) const
Definition: swrect.hxx:159
geometry::RealSize2D m_Size
tools::Rectangle & operator+=(tools::Rectangle &rRect, const SvBorder &rBorder)
tools::Long AdjustHeight(tools::Long n)
std::basic_ostream< charT, traits > & operator<<(std::basic_ostream< charT, traits > &stream, const SwRect &rectangle)
Definition: swrect.hxx:332
Size(SwRect::* SwRectSize)() const
Definition: swrect.hxx:157
void setHeight(tools::Long nHeight)
void Clear()
Definition: swrect.hxx:296
Left
bool operator!=(const SwRect &rRect) const
Definition: swrect.hxx:263
SwRect & operator-=(const Point &rPt)
Definition: swrect.hxx:273
Point(SwRect::* SwRectPoint)() const
Definition: swrect.hxx:156
void Chg(const Point &rNP, const Size &rNS)
Definition: swrect.hxx:164
tools::Long Width() const
Definition: swrect.hxx:227
const Point & Pos() const
Definition: swrect.hxx:215
void(SwRect::* SwRectSetPos)(const Point &)
Definition: swrect.hxx:161
bool operator==(const SwRect &rRect) const
Definition: swrect.hxx:259
SwRect()
Definition: swrect.hxx:305
SvStream & WriteSwRect(SvStream &rStream, const SwRect &rRect)
Definition: swrect.cxx:232
typedef void(CALLTYPE *GetFuncDataPtr)(sal_uInt16 &nNo