office-gobmx/sw/inc/swrect.hxx
Caolán McNamara 3fd0889013 add SAL_WARN_UNUSED to some classes
Change-Id: Ibcc3ea7ebd60c46930f0c2419c8286fed9671061
2012-10-28 12:04:15 +00:00

365 lines
10 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _SWRECT_HXX
#define _SWRECT_HXX
#include <osl/diagnose.h>
#include <tools/gen.hxx>
class SvStream;
class SAL_WARN_UNUSED 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 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();
inline Size &SSize();
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 );
inline SwRect GetIntersection( const SwRect& rRect ) const;
sal_Bool IsInside( const Point& rPOINT ) const;
sal_Bool IsNear(const Point& rPoint, long nTolerance ) const;
sal_Bool IsInside( const SwRect& rRect ) const;
sal_Bool IsOver( const SwRect& rRect ) const;
inline sal_Bool HasArea() const;
inline sal_Bool IsEmpty() const;
inline void Clear();
inline SwRect &operator = ( const SwRect &rRect );
inline sal_Bool operator == ( const SwRect& rRect ) const;
inline sal_Bool operator != ( const SwRect& rRect ) const;
inline SwRect &operator+=( const Point &rPt );
inline SwRect &operator-=( const Point &rPt );
inline SwRect &operator+=( const Size &rSz );
inline SwRect &operator-=( const Size &rSz );
//SV-SS e.g. pWin->DrawRect( aSwRect.SVRect() );
inline Rectangle SVRect() const;
// Output operator for debugging.
friend SvStream &operator<<( SvStream &rStream, const SwRect &rRect );
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 AddBottom( 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 );
const Size _Size() const;
const Point TopLeft() const;
const Point TopRight() const;
const Point BottomLeft() const;
const Point BottomRight() const;
const Size SwappedSize() const;
long GetLeftDistance( long ) const;
long GetBottomDistance( long ) const;
long GetRightDistance( long ) const;
long GetTopDistance( long ) const;
sal_Bool OverStepLeft( long ) const;
sal_Bool OverStepBottom( long ) const;
sal_Bool OverStepTop( long ) const;
sal_Bool OverStepRight( long ) const;
};
#ifdef DBG_UTIL
// Implementation in swrect.cxx
extern SvStream &operator<<( SvStream &rStream, const SwRect &rRect );
#endif
typedef void (SwRect:: *SwRectSet)( const long nNew );
typedef long (SwRect:: *SwRectGet)() const;
typedef const Point (SwRect:: *SwRectPoint)() const;
typedef const Size (SwRect:: *SwRectSize)() const;
typedef sal_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.Width() += 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.Height() += 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 Size &SwRect::SSize()
{
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 sal_Bool SwRect::operator == ( const SwRect& rRect ) const
{
return (m_Point == rRect.m_Point && m_Size == rRect.m_Size);
}
inline sal_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;
}
inline SwRect &SwRect::operator+=( const Size &rSz )
{
m_Size.Width() += rSz.Width();
m_Size.Height() += rSz.Height();
return *this;
}
inline SwRect &SwRect::operator-=( const Size &rSz )
{
m_Size.Width() -= rSz.Width();
m_Size.Height() -= rSz.Height();
return *this;
}
// other
inline Rectangle SwRect::SVRect() const
{
OSL_ENSURE( !IsEmpty(), "SVRect() without Width or Height" );
return Rectangle( m_Point.getX(), m_Point.getY(),
m_Point.getX() + m_Size.getWidth() - 1, //Right()
m_Point.getY() + m_Size.getHeight() - 1 ); //Bottom()
}
inline SwRect SwRect::GetIntersection( const SwRect& rRect ) const
{
return SwRect( *this ).Intersection( rRect );
}
inline sal_Bool SwRect::HasArea() const
{
return !IsEmpty();
}
inline sal_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 )
{
}
#endif //_SWRECT_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */