diff options
Diffstat (limited to 'sw/inc/swrect.hxx')
| -rw-r--r-- | sw/inc/swrect.hxx | 343 |
1 files changed, 343 insertions, 0 deletions
diff --git a/sw/inc/swrect.hxx b/sw/inc/swrect.hxx new file mode 100644 index 000000000..b2c5279dc --- /dev/null +++ b/sw/inc/swrect.hxx @@ -0,0 +1,343 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef INCLUDED_SW_INC_SWRECT_HXX +#define INCLUDED_SW_INC_SWRECT_HXX + +#include <ostream> + +#include <sal/log.hxx> +#include <tools/gen.hxx> +#include "swdllapi.h" + +class SvStream; +typedef struct _xmlTextWriter* xmlTextWriterPtr; + +/// *Of course* Writer needs its own rectangles. +/// This is half-open so m_Point.X() + m_Size.getWidth() is *not* included. +/// Note the tools Rectangle is (usually? sometimes?) closed so there's a +/// SVRect() to subtract 1 for the conversion. +class SAL_WARN_UNUSED SW_DLLPUBLIC SwRect +{ + Point m_Point; + Size m_Size; + +public: + inline SwRect(); + inline SwRect( const SwRect &rRect ); + inline SwRect( const Point& rLT, const Size& rSize ); + inline SwRect( const Point& rLT, const Point& rRB ); + inline SwRect( long X, long Y, long Width, long Height ); + + //SV-SS e.g. SwRect( pWin->GetClipRect() ); + SwRect( const tools::Rectangle &rRect ); + + //Set-Methods + inline void Chg( const Point& rNP, const Size &rNS ); + inline void Pos( const Point& rNew ); + inline void Pos( const long nNewX, const long nNewY ); + inline void SSize( const Size& rNew ); + inline void SSize( const long nHeight, const long nWidth ); + inline void Width( long nNew ); + inline void Height( long nNew ); + inline void Left( const long nLeft ); + inline void Right( const long nRight ); + inline void Top( const long nTop ); + inline void Bottom( const long nBottom ); + + //Get-Methods + inline const Point &Pos() const; + inline const Size &SSize() const; + inline long Width() const; + inline long Height() const; + inline long Left() const; + inline long Right() const; + inline long Top() const; + inline long Bottom() const; + + // In order to be able to access the members of Pos and SSize from the layout side. + inline Point &Pos(); + + Point Center() const; + + void Justify(); + + SwRect &Union( const SwRect& rRect ); + SwRect &Intersection( const SwRect& rRect ); + + // Same as Intersection, only assume that Rects are overlapping! + SwRect &Intersection_( const SwRect &rRect ); + + bool IsInside( const Point& rPOINT ) const; + bool IsNear(const Point& rPoint, long nTolerance ) const; + bool IsInside( const SwRect& rRect ) const; + bool IsOver( const SwRect& rRect ) const; + inline bool HasArea() const; + inline bool IsEmpty() const; + inline void Clear(); + + inline SwRect &operator = ( const SwRect &rRect ); + + inline bool operator == ( const SwRect& rRect ) const; + inline bool operator != ( const SwRect& rRect ) const; + + inline SwRect &operator+=( const Point &rPt ); + inline SwRect &operator-=( const Point &rPt ); + + //SV-SS e.g. pWin->DrawRect( aSwRect.SVRect() ); + inline tools::Rectangle SVRect() const; + + // Output operator for debugging. + friend SvStream& WriteSwRect( SvStream &rStream, const SwRect &rRect ); + void dumpAsXmlAttributes(xmlTextWriterPtr writer) const; + + void Top_( const long nTop ); + void Bottom_( const long nBottom ); + void Left_( const long nLeft ); + void Right_( const long nRight ); + void Width_( const long nNew ); + void Height_( const long nNew ); + long Top_() const; + long Bottom_() const; + long Left_() const; + long Right_() const; + long Width_() const; + long Height_() const; + void SubTop( const long nSub ); + void AddTop( const long nAdd ); + void AddBottom( const long nAdd ); + void AddLeft( const long nAdd ); + void SubLeft( const long nSub ); + void AddRight( const long nAdd ); + void AddWidth( const long nAdd ); + void AddHeight( const long nAdd ); + void SetPosX( const long nNew ); + void SetPosY( const long nNew ); + void SetLeftAndWidth( long nLeft, long nNew ); + void SetTopAndHeight( long nTop, long nNew ); + void SetRightAndWidth( long nRight, long nNew ); + void SetBottomAndHeight( long nBottom, long nNew ); + void SetUpperLeftCorner( const Point& rNew ); + void SetUpperRightCorner( const Point& rNew ); + void SetLowerLeftCorner( const Point& rNew ); + Size Size_() const; + Point TopLeft() const; + Point TopRight() const; + Point BottomLeft() const; + Point BottomRight() const; + Size SwappedSize() const; + long GetLeftDistance( long ) const; + long GetBottomDistance( long ) const; + long GetRightDistance( long ) const; + long GetTopDistance( long ) const; + bool OverStepLeft( long ) const; + bool OverStepBottom( long ) const; + bool OverStepTop( long ) const; + bool OverStepRight( long ) const; +}; + +typedef void (SwRect:: *SwRectSet)( const long nNew ); +typedef long (SwRect:: *SwRectGet)() const; +typedef Point (SwRect:: *SwRectPoint)() const; +typedef Size (SwRect:: *SwRectSize)() const; +typedef bool (SwRect:: *SwRectMax)( long ) const; +typedef long (SwRect:: *SwRectDist)( long ) const; +typedef void (SwRect:: *SwRectSetTwice)( long, long ); +typedef void (SwRect:: *SwRectSetPos)( const Point& ); + +// Set-Methods +inline void SwRect::Chg( const Point& rNP, const Size &rNS ) +{ + m_Point = rNP; + m_Size = rNS; +} +inline void SwRect::Pos( const Point& rNew ) +{ + m_Point = rNew; +} +inline void SwRect::Pos( const long nNewX, const long nNewY ) +{ + m_Point.setX(nNewX); + m_Point.setY(nNewY); +} +inline void SwRect::SSize( const Size& rNew ) +{ + m_Size = rNew; +} +inline void SwRect::SSize( const long nNewHeight, const long nNewWidth ) +{ + m_Size.setWidth(nNewWidth); + m_Size.setHeight(nNewHeight); +} +inline void SwRect::Width( long nNew ) +{ + m_Size.setWidth(nNew); +} +inline void SwRect::Height( long nNew ) +{ + m_Size.setHeight(nNew); +} +inline void SwRect::Left( const long nLeft ) +{ + m_Size.AdjustWidth( m_Point.getX() - nLeft ); + m_Point.setX(nLeft); +} +inline void SwRect::Right( const long nRight ) +{ + m_Size.setWidth(nRight - m_Point.getX() + 1); +} +inline void SwRect::Top( const long nTop ) +{ + m_Size.AdjustHeight( m_Point.getY() - nTop ); + m_Point.setY(nTop); +} +inline void SwRect::Bottom( const long nBottom ) +{ + m_Size.setHeight(nBottom - m_Point.getY() + 1); +} + +// Get-Methods +inline const Point &SwRect::Pos() const +{ + return m_Point; +} +inline Point &SwRect::Pos() +{ + return m_Point; +} +inline const Size &SwRect::SSize() const +{ + return m_Size; +} +inline long SwRect::Width() const +{ + return m_Size.Width(); +} +inline long SwRect::Height() const +{ + return m_Size.Height(); +} +inline long SwRect::Left() const +{ + return m_Point.X(); +} +inline long SwRect::Right() const +{ + return m_Size.getWidth() ? m_Point.getX() + m_Size.getWidth() - 1 : m_Point.getX(); +} +inline long SwRect::Top() const +{ + return m_Point.Y(); +} +inline long SwRect::Bottom() const +{ + return m_Size.getHeight() ? m_Point.getY() + m_Size.getHeight() - 1 : m_Point.getY(); +} + +// operators +inline SwRect &SwRect::operator = ( const SwRect &rRect ) +{ + m_Point = rRect.m_Point; + m_Size = rRect.m_Size; + return *this; +} +inline bool SwRect::operator == ( const SwRect& rRect ) const +{ + return (m_Point == rRect.m_Point && m_Size == rRect.m_Size); +} +inline bool SwRect::operator != ( const SwRect& rRect ) const +{ + return (m_Point != rRect.m_Point || m_Size != rRect.m_Size); +} + +inline SwRect &SwRect::operator+=( const Point &rPt ) +{ + m_Point += rPt; + return *this; +} +inline SwRect &SwRect::operator-=( const Point &rPt ) +{ + m_Point -= rPt; + return *this; +} + +// other +inline tools::Rectangle SwRect::SVRect() const +{ + SAL_WARN_IF( IsEmpty(), "sw", "SVRect() without Width or Height" ); + return tools::Rectangle( m_Point.getX(), m_Point.getY(), + m_Point.getX() + m_Size.getWidth() - 1, //Right() + m_Point.getY() + m_Size.getHeight() - 1 ); //Bottom() +} + +inline bool SwRect::HasArea() const +{ + return !IsEmpty(); +} +inline bool SwRect::IsEmpty() const +{ + return !(m_Size.getHeight() && m_Size.getWidth()); +} +inline void SwRect::Clear() +{ + m_Point.setX(0); + m_Point.setY(0); + m_Size.setWidth(0); + m_Size.setHeight(0); +} + +// constructors +inline SwRect::SwRect() : + m_Point( 0, 0 ), + m_Size( 0, 0 ) +{ +} +inline SwRect::SwRect( const SwRect &rRect ) : + m_Point( rRect.m_Point ), + m_Size( rRect.m_Size ) +{ +} +inline SwRect::SwRect( const Point& rLT, const Size& rSize ) : + m_Point( rLT ), + m_Size( rSize ) +{ +} +inline SwRect::SwRect( const Point& rLT, const Point& rRB ) : + m_Point( rLT ), + m_Size( rRB.X() - rLT.X() + 1, rRB.Y() - rLT.Y() + 1 ) +{ +} +inline SwRect::SwRect( long X, long Y, long W, long H ) : + m_Point( X, Y ), + m_Size( W, H ) +{ +} + +template< typename charT, typename traits > +inline std::basic_ostream<charT, traits> & operator <<( + std::basic_ostream<charT, traits> & stream, const SwRect& rectangle ) +{ + if (rectangle.IsEmpty()) + stream << "EMPTY:"; + return stream << rectangle.SSize() + << "@(" << rectangle.Pos() << ")"; +} + +#endif // INCLUDED_SW_INC_SWRECT_HXX + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |