sw/source/core/text/widorp.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: widorp.hxx,v $
  10  * $Revision: 1.8.214.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _WIDORP_HXX
  31 #define _WIDORP_HXX
  32 class SwTxtFrm;
  33
  34 #include "swtypes.hxx"
  35 #include "itrtxt.hxx"
  36
  37 class SwTxtFrmBreak
  38 {
  39 private:
  40     SwTwips  nRstHeight;
  41     SwTwips  nOrigin;
  42 protected:
  43     SwTxtFrm *pFrm;
  44     sal_Bool     bBreak;
  45     sal_Bool     bKeep;
  46 public:
  47     SwTxtFrmBreak( SwTxtFrm *pFrm, const SwTwips nRst = 0  );
  48     sal_Bool IsBreakNow( SwTxtMargin &rLine );
  49
  50     sal_Bool IsBroken() const   { return bBreak; }
  51     sal_Bool IsKeepAlways() const { return bKeep; }
  52     void Keep()                         { bKeep = sal_True; }
  53     void Break()                                { bKeep = sal_False; bBreak = sal_True; }
  54
  55     inline sal_Bool GetKeep() const { return bKeep; }
  56     inline void SetKeep( const sal_Bool bNew ) { bKeep = bNew; }
  57
  58     sal_Bool IsInside( SwTxtMargin &rLine ) const;
  59
  60     // Um Sonderfaelle mit Ftn behandeln zu koennen.
  61     // Mit SetRstHeight wird dem SwTxtFrmBreak die Resthoehe eingestellt,
  62     // Um TruncLines() rufen zu koennen, ohne dass IsBreakNow() einen
  63     // anderen Wert zurueckliefert.
  64     // Es wird dabei davon ausgegangen, dass rLine auf der letzten Zeile
  65     // steht, die nicht mehr passt.
  66
  67     // OD 2004-02-27 #106629# - no longer inline
  68     void SetRstHeight( const SwTxtMargin &rLine );
  69     SwTwips GetRstHeight() const { return nRstHeight; }
  70 };
  71
  72 class WidowsAndOrphans : public SwTxtFrmBreak
  73 {
  74 private:
  75     MSHORT       nWidLines, nOrphLines;
  76
  77 public:
  78     WidowsAndOrphans( SwTxtFrm *pFrm, const SwTwips nRst = 0,
  79         sal_Bool bCheckKeep = sal_True );
  80     sal_Bool FindWidows( SwTxtFrm *pFrm, SwTxtMargin &rLine );
  81     MSHORT GetWidowsLines() const
  82     { return nWidLines; }
  83     MSHORT GetOrphansLines() const
  84     { return nOrphLines; }
  85     void ClrOrphLines(){ nOrphLines = 0; }
  86
  87     sal_Bool FindBreak( SwTxtFrm *pFrm, SwTxtMargin &rLine, sal_Bool bHasToFit );
  88     sal_Bool WouldFit( SwTxtMargin &rLine, SwTwips &rMaxHeight, sal_Bool bTest );
  89     // OD 2004-02-25 #i16128# - rename method to avoid confusion with base class
  90     // method <SwTxtFrmBreak::IsBreakNow>, which isn't virtual.
  91     sal_Bool IsBreakNowWidAndOrp( SwTxtMargin &rLine )
  92     {
  93         return ( rLine.GetLineNr() > nOrphLines ) && IsBreakNow( rLine );
  94     }
  95 };
  96
  97
  98 #endif