sw/inc/swrect.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 #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
  31 /// *Of course* Writer needs its own rectangles.
  32 /// This is half-open so m_Point.X() + m_Size.getWidth() is *not* included.
  33 /// Note the tools Rectangle is (usually? sometimes?) closed so there's a
  34 /// SVRect() to subtract 1 for the conversion.
  35 class SAL_WARN_UNUSED SW_DLLPUBLIC SwRect
  36 {
  37     Point m_Point;
  38     Size m_Size;
  39
  40 public:
  41     inline SwRect();
  42     inline SwRect( const SwRect &rRect ) = default;
  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     {
  82         if ( Top() > rRect.Top() )
  83             Top( rRect.Top() );
  84         if ( Left() > rRect.Left() )
  85             Left( rRect.Left() );
  86         tools::Long n = rRect.Right();
  87         if ( Right() < n )
  88             Right( n );
  89         n = rRect.Bottom();
  90         if ( Bottom() < n )
  91             Bottom( n );
  92         return *this;
  93     }
  94     SwRect &Intersection( const SwRect& rRect );
  95
  96     // Same as Intersection, only assume that Rects are overlapping!
  97     SwRect &Intersection_( const SwRect &rRect );
  98
  99     bool IsInside( const Point& rPoint ) const
 100     {
 101         return (Left()  <= rPoint.X()) &&
 102                (Top()   <= rPoint.Y()) &&
 103                (Right() >= rPoint.X()) &&
 104                (Bottom()>= rPoint.Y());
 105     }
 106     bool IsNear(const Point& rPoint, tools::Long nTolerance ) const;
 107     bool IsInside( const SwRect& rRect ) const
 108     {
 109         const tools::Long nRight  = Right();
 110         const tools::Long nBottom = Bottom();
 111         const tools::Long nrRight = rRect.Right();
 112         const tools::Long nrBottom= rRect.Bottom();
 113         return (Left() <= rRect.Left()) && (rRect.Left()<= nRight)  &&
 114                (Left() <= nrRight)      && (nrRight     <= nRight)  &&
 115                (Top()  <= rRect.Top())  && (rRect.Top() <= nBottom) &&
 116                (Top()  <= nrBottom)     && (nrBottom    <= nBottom);
 117     }
 118     bool IsOver( const SwRect& rRect ) const;
 119     inline bool HasArea() const;
 120     inline bool IsEmpty() const;
 121     inline void Clear();
 122
 123     SwRect &operator = ( const SwRect &rRect ) = default;
 124
 125     inline bool operator == ( const SwRect& rRect ) const;
 126     inline bool operator != ( const SwRect& rRect ) const;
 127
 128     inline SwRect &operator+=( const Point &rPt );
 129     inline SwRect &operator-=( const Point &rPt );
 130
 131     //SV-SS e.g. pWin->DrawRect( aSwRect.SVRect() );
 132     inline tools::Rectangle  SVRect() const;
 133
 134     // Output operator for debugging.
 135     friend SvStream& WriteSwRect( SvStream &rStream, const SwRect &rRect );
 136     void dumpAsXmlAttributes(xmlTextWriterPtr writer) const;
 137
 138     void Top_(      const tools::Long nTop );
 139     void Bottom_(   const tools::Long nBottom );
 140     void Left_(     const tools::Long nLeft );
 141     void Right_(    const tools::Long nRight );
 142     void Width_(    const tools::Long nNew );
 143     void Height_(   const tools::Long nNew );
 144     tools::Long Top_()     const;
 145     tools::Long Bottom_()  const;
 146     tools::Long Left_()    const;
 147     tools::Long Right_()   const;
 148     tools::Long Width_()   const;
 149     tools::Long Height_()  const;
 150     void SubTop(    const tools::Long nSub );
 151     void AddTop(    const tools::Long nAdd );
 152     void AddBottom( const tools::Long nAdd );
 153     void AddLeft(   const tools::Long nAdd );
 154     void SubLeft(   const tools::Long nSub );
 155     void AddRight(  const tools::Long nAdd );
 156     void AddWidth(  const tools::Long nAdd );
 157     void AddHeight( const tools::Long nAdd );
 158     void SetPosX(   const tools::Long nNew );
 159     void SetPosY(   const tools::Long nNew );
 160     void SetLeftAndWidth( tools::Long nLeft, tools::Long nNew );
 161     void SetTopAndHeight( tools::Long nTop, tools::Long nNew );
 162     void SetRightAndWidth( tools::Long nRight, tools::Long nNew );
 163     void SetBottomAndHeight( tools::Long nBottom, tools::Long nNew );
 164     void SetUpperLeftCorner(  const Point& rNew );
 165     void SetUpperRightCorner(  const Point& rNew );
 166     void SetLowerLeftCorner(  const Point& rNew );
 167     Size  Size_() const;
 168     Point TopLeft()  const;
 169     Point TopRight()  const;
 170     Point BottomLeft()  const;
 171     Point BottomRight()  const;
 172     Size  SwappedSize() const;
 173     tools::Long GetLeftDistance( tools::Long ) const;
 174     tools::Long GetBottomDistance( tools::Long ) const;
 175     tools::Long GetRightDistance( tools::Long ) const;
 176     tools::Long GetTopDistance( tools::Long ) const;
 177     bool OverStepLeft( tools::Long ) const;
 178     bool OverStepBottom( tools::Long ) const;
 179     bool OverStepTop( tools::Long ) const;
 180     bool OverStepRight( tools::Long ) const;
 181 };
 182
 183 typedef void (SwRect::*SwRectSet)( const tools::Long nNew );
 184 typedef tools::Long (SwRect::*SwRectGet)() const;
 185 typedef Point (SwRect::*SwRectPoint)() const;
 186 typedef Size (SwRect::*SwRectSize)() const;
 187 typedef bool (SwRect::*SwRectMax)( tools::Long ) const;
 188 typedef tools::Long (SwRect::*SwRectDist)( tools::Long ) const;
 189 typedef void (SwRect::*SwRectSetTwice)( tools::Long, tools::Long );
 190 typedef void (SwRect::*SwRectSetPos)( const Point& );
 191
 192 //  Set-Methods
 193 inline void SwRect::Chg( const Point& rNP, const Size &rNS )
 194 {
 195     m_Point = rNP;
 196     m_Size = rNS;
 197 }
 198 inline void SwRect::Pos(  const Point& rNew )
 199 {
 200     m_Point = rNew;
 201 }
 202 inline void SwRect::Pos( const tools::Long nNewX, const tools::Long nNewY )
 203 {
 204     m_Point.setX(nNewX);
 205     m_Point.setY(nNewY);
 206 }
 207 inline void SwRect::SSize( const Size&  rNew  )
 208 {
 209     m_Size = rNew;
 210 }
 211 inline void SwRect::SSize( const tools::Long nNewHeight, const tools::Long nNewWidth )
 212 {
 213     m_Size.setWidth(nNewWidth);
 214     m_Size.setHeight(nNewHeight);
 215 }
 216 inline void SwRect::Width(  tools::Long nNew )
 217 {
 218     m_Size.setWidth(nNew);
 219 }
 220 inline void SwRect::Height( tools::Long nNew )
 221 {
 222     m_Size.setHeight(nNew);
 223 }
 224 inline void SwRect::Left( const tools::Long nLeft )
 225 {
 226     m_Size.AdjustWidth( m_Point.getX() - nLeft );
 227     m_Point.setX(nLeft);
 228 }
 229 inline void SwRect::Right( const tools::Long nRight )
 230 {
 231     m_Size.setWidth(nRight - m_Point.getX() + 1);
 232 }
 233 inline void SwRect::Top( const tools::Long nTop )
 234 {
 235     m_Size.AdjustHeight( m_Point.getY() - nTop );
 236     m_Point.setY(nTop);
 237 }
 238 inline void SwRect::Bottom( const tools::Long nBottom )
 239 {
 240     m_Size.setHeight(nBottom - m_Point.getY() + 1);
 241 }
 242
 243 // Get-Methods
 244 inline const Point &SwRect::Pos()  const
 245 {
 246     return m_Point;
 247 }
 248 inline Point &SwRect::Pos()
 249 {
 250     return m_Point;
 251 }
 252 inline const Size  &SwRect::SSize() const
 253 {
 254     return m_Size;
 255 }
 256 inline tools::Long SwRect::Width()  const
 257 {
 258     return m_Size.Width();
 259 }
 260 inline tools::Long SwRect::Height() const
 261 {
 262     return m_Size.Height();
 263 }
 264 inline tools::Long SwRect::Left()   const
 265 {
 266     return m_Point.X();
 267 }
 268 inline tools::Long SwRect::Right()  const
 269 {
 270     return m_Size.getWidth() ? m_Point.getX() + m_Size.getWidth() - 1 : m_Point.getX();
 271 }
 272 inline tools::Long SwRect::Top()    const
 273 {
 274     return m_Point.Y();
 275 }
 276 inline tools::Long SwRect::Bottom() const
 277 {
 278     return m_Size.getHeight() ? m_Point.getY() + m_Size.getHeight() - 1 : m_Point.getY();
 279 }
 280
 281 inline Point SwRect::TopLeft() const
 282 {
 283     return Point( Left(), Top());
 284 }
 285 inline Point SwRect::TopRight() const
 286 {
 287     return Point( Right(), Top());
 288 }
 289 inline Point SwRect::BottomLeft() const
 290 {
 291     return Point( Left(), Bottom());
 292 }
 293 inline Point SwRect::BottomRight() const
 294 {
 295     return Point( Right(), Bottom());
 296 }
 297
 298 inline bool SwRect::operator == ( const SwRect& rRect ) const
 299 {
 300     return (m_Point == rRect.m_Point && m_Size == rRect.m_Size);
 301 }
 302 inline bool SwRect::operator != ( const SwRect& rRect ) const
 303 {
 304     return (m_Point != rRect.m_Point || m_Size != rRect.m_Size);
 305 }
 306
 307 inline SwRect &SwRect::operator+=( const Point &rPt )
 308 {
 309     m_Point += rPt;
 310     return *this;
 311 }
 312 inline SwRect &SwRect::operator-=( const Point &rPt )
 313 {
 314     m_Point -= rPt;
 315     return *this;
 316 }
 317
 318 // other
 319 inline tools::Rectangle SwRect::SVRect() const
 320 {
 321     SAL_WARN_IF( IsEmpty(), "sw", "SVRect() without Width or Height" );
 322     return tools::Rectangle( m_Point.getX(), m_Point.getY(),
 323         m_Point.getX() + m_Size.getWidth() - 1,         //Right()
 324         m_Point.getY() + m_Size.getHeight() - 1 );      //Bottom()
 325 }
 326
 327 inline bool SwRect::HasArea() const
 328 {
 329     return !IsEmpty();
 330 }
 331 inline bool SwRect::IsEmpty() const
 332 {
 333     return !(m_Size.getHeight() && m_Size.getWidth());
 334 }
 335 inline void SwRect::Clear()
 336 {
 337     m_Point.setX(0);
 338     m_Point.setY(0);
 339     m_Size.setWidth(0);
 340     m_Size.setHeight(0);
 341 }
 342
 343 // constructors
 344 inline SwRect::SwRect() :
 345     m_Point( 0, 0 ),
 346     m_Size( 0, 0 )
 347 {
 348 }
 349 inline SwRect::SwRect( const Point& rLT, const Size&  rSize ) :
 350     m_Point( rLT ),
 351     m_Size( rSize )
 352 {
 353 }
 354 inline SwRect::SwRect( const Point& rLT, const Point& rRB ) :
 355     m_Point( rLT ),
 356     m_Size( rRB.X() - rLT.X() + 1, rRB.Y() - rLT.Y() + 1 )
 357 {
 358 }
 359 inline SwRect::SwRect( tools::Long X, tools::Long Y, tools::Long W, tools::Long H ) :
 360     m_Point( X, Y ),
 361     m_Size( W, H )
 362 {
 363 }
 364
 365 template< typename charT, typename traits >
 366 inline std::basic_ostream<charT, traits> & operator <<(
 367     std::basic_ostream<charT, traits> & stream, const SwRect& rectangle )
 368 {
 369     if (rectangle.IsEmpty())
 370         stream << "EMPTY:";
 371     return stream << rectangle.SSize()
 372                   << "@(" << rectangle.Pos() << ")";
 373 }
 374
 375 #endif // INCLUDED_SW_INC_SWRECT_HXX
 376
 377 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */