AOO410/main/sw/source/core/inc/flowfrm.hxx - openoffice - Git at Google

 /**************************************************************
  *
  * 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
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  *
  *************************************************************/


 #ifndef _FLOWFRM_HXX
 #define _FLOWFRM_HXX

 //Der FlowFrm gibt die Funktionalitaet fuer alle Frms vor, die fliessen und
 //die sich aufspalten koennen (wie CntntFrm oder TabFrm).
 //Teile der Funktionalitaet sind im FlowFrm implementiert, andere Teile werden
 //von den spezifischen Frms implementiert.
 //Der FlowFrm ist kein eigenstaender Frm, es kann also auch niemals eine
 //eigenstaendige Instanz vom FlowFrm existieren.
 //Der FlowFrm ist nicht einmal ein echter Frm. Die naheliegende Implementierung
 //waere ein FlowFrm der virtual vom SwFrm abgeleitet ist und direkt auf den
 //eigenen Instanzdaten arbeitet. Abgeleitete Klassen muessten sich
 //vom FlowFrm und (ueber mehrere Basisklassen weil der Klassenbaum sich direkt
 //vom SwFrm zu SwCntntFrm und zum SwLayoutFrm spaltet) virtual vom SwFrm
 //ableiten.
 //Leider entstehen dadurch - neben Problemen mit Compilern und Debuggern -
 //erhebliche zusaetzliche Kosten, die wir uns heutzutage IMHO nicht erlauben
 //koennen.
 //Ich greife deshalb auf eine andere Technik zurueck: Der FlowFrm hat eine
 //Referenz auf den SwFrm - der er genau betrachtet selbst ist - und ist mit
 //diesem befreundet. So kann der FlowFrm anstelle des this-Pointer mit der
 //Referenz auf den SwFrm arbeiten.

 //#include "frame.hxx"   //fuer inlines

 class SwPageFrm;
 class SwRect;
 class SwBorderAttrs;
 class SwDoc;
 class SwNodeIndex;
 // --> OD 2005-03-04 #i44049#
 class SwObjectFormatterTxtFrm;
 // <--

 void MakeFrms( SwDoc *, const SwNodeIndex &, const SwNodeIndex & );

 class SwFlowFrm
 {
 	//PrepareMake darf Locken/Unlocken (Robustheit)
 	friend inline void PrepareLock  ( SwFlowFrm * );
 	friend inline void PrepareUnlock( SwFlowFrm * );
     friend inline void TableSplitRecalcLock( SwFlowFrm * );
     friend inline void TableSplitRecalcUnlock( SwFlowFrm * );
     // --> OD 2005-03-04 #i44049#
     friend class SwObjectFormatterTxtFrm;
     // <--

 	//TblSel darf das Follow-Bit zuruecksetzen.
 	friend inline void UnsetFollow( SwFlowFrm *pFlow );

 	friend void MakeFrms( SwDoc *, const SwNodeIndex &, const SwNodeIndex & );

 	friend class SwNode2LayImpl;

 	SwFrm &rThis;

 	//Hilfsfunktionen fuer MoveSubTree()
 	static SwLayoutFrm *CutTree( SwFrm* );
 	static sal_Bool   PasteTree( SwFrm *, SwLayoutFrm *, SwFrm *, SwFrm* );

 	//Wird fuer das Zusammenspiel von _GetPrevxxx und MoveBwd gebraucht, damit
 	//mehrere Blaetter gleichzeitig uebersprungen werden koennen.
 	//Wird auch vom MoveBwd des TabFrm ausgewertet!
 	static sal_Bool bMoveBwdJump;

     /** helper method to determine previous frame for calculation of the
         upper space

         OD 2004-03-10 #i11860#

         @param _pProposedPrevFrm
         optional input parameter - pointer to frame, which should be used
         instead of the direct previous frame.

         @author OD
     */
     const SwFrm* _GetPrevFrmForUpperSpaceCalc( const SwFrm* _pProposedPrevFrm = 0L ) const;

     /** method to detemine the upper space amount, which is considered for
         the previous frame

         OD 2004-03-11 #i11860#

         @author OD
     */
     SwTwips _GetUpperSpaceAmountConsideredForPrevFrm() const;

     /** method to detemine the upper space amount, which is considered for
         the page grid

         OD 2004-03-12 #i11860#

         @author OD
     */
     SwTwips _GetUpperSpaceAmountConsideredForPageGrid(
                                 const SwTwips _nUpperSpaceWithoutGrid ) const;

 protected:

 	SwFlowFrm *pFollow;

 	sal_Bool bIsFollow	:1;	//Ist's ein Follow
 	sal_Bool bLockJoin	:1;	//Join (und damit deleten) verboten wenn sal_True!
 	sal_Bool bUndersized:1; // wir sind kleiner als gewuenscht
 	sal_Bool bFtnAtEnd	:1; // For sectionfrms only: footnotes at the end of section
 	sal_Bool bEndnAtEnd	:1; // 	"		"		 " : endnotes at the end of section
 	sal_Bool bCntntLock	:1; //  "       "        " : content locked
 	sal_Bool bOwnFtnNum	:1; //  "       "        " : special numbering of footnotes
 	sal_Bool bFtnLock	:1; //  "       "        " : ftn, don't leave this section bwd
     sal_Bool bFlyLock   :1; //  Stop positioning of at-character flyframes

 	//Prueft ob Vorwaertsfluss noch Sinn macht Endloswanderschaften (unterbinden)
 	inline sal_Bool IsFwdMoveAllowed();
     // --> OD 2005-03-08 #i44049# - method <CalcCntnt(..)> has to check this property.
     friend void CalcCntnt( SwLayoutFrm *pLay, bool bNoColl, bool bNoCalcFollow );
     // <--
 	sal_Bool IsKeepFwdMoveAllowed();	//Wie oben, Move fuer Keep.

 	//Prueft ob ein Obj das Umlauf wuenscht ueberlappt.
 	//eine Null bedeutet, kein Objekt ueberlappt,
 	// 1 heisst, Objekte, die am FlowFrm selbst verankert sind, ueberlappen
 	// 2 heisst, Objekte, die woanders verankert sind, ueberlappen
 	// 3 heistt, beiderlei verankerte Objekte ueberlappen
 	sal_uInt8 BwdMoveNecessary( const SwPageFrm *pPage, const SwRect &rRect );

 	void LockJoin()   { bLockJoin = sal_True;  }
 	void UnlockJoin() { bLockJoin = sal_False; }

 			sal_Bool CheckMoveFwd( sal_Bool &rbMakePage, sal_Bool bKeep, sal_Bool bMovedBwd );
 			sal_Bool MoveFwd( sal_Bool bMakePage, sal_Bool bPageBreak, sal_Bool bMoveAlways = sal_False );
 	virtual sal_Bool ShouldBwdMoved( SwLayoutFrm *pNewUpper, sal_Bool bHead, sal_Bool &rReformat )=0;
 			sal_Bool MoveBwd( sal_Bool &rbReformat );

 public:
 	SwFlowFrm( SwFrm &rFrm );

 	const SwFrm *GetFrm() const 		   { return &rThis; }
 		  SwFrm *GetFrm()				   { return &rThis; }

 	static sal_Bool IsMoveBwdJump()			   { return bMoveBwdJump; }
 	static void SetMoveBwdJump( sal_Bool bNew ){ bMoveBwdJump = bNew; }

 	inline void SetUndersized( const sal_Bool bNew ) { bUndersized = bNew; }
 	inline sal_Bool IsUndersized() 	const { return bUndersized;	}

 	sal_Bool IsPrevObjMove() const;

 	//Die Kette mit minimalen Operationen und Benachrichtigungen unter den
 	//neuen Parent Moven.
 	void MoveSubTree( SwLayoutFrm* pParent, SwFrm* pSibling = 0 );

 		   sal_Bool 	  HasFollow() const    { return pFollow ? sal_True : sal_False; }
 		   sal_Bool		  IsFollow()     const { return bIsFollow; }
 	inline void		  _SetIsFollow( sal_Bool bSet ) { bIsFollow = bSet; }
 	const  SwFlowFrm *GetFollow() const	   { return pFollow;   }
 		   SwFlowFrm *GetFollow()	   	   { return pFollow;   }
 		   sal_Bool  	  IsAnFollow( const SwFlowFrm *pFlow ) const;
 	inline void   	  SetFollow( SwFlowFrm *pNew ) { pFollow = pNew; }

     sal_Bool IsJoinLocked() const { return bLockJoin; }
     sal_Bool IsAnyJoinLocked() const { return bLockJoin || HasLockedFollow(); }
 	sal_Bool IsFtnAtEnd() const { return bFtnAtEnd;	}
 	sal_Bool IsEndnAtEnd() const { return bEndnAtEnd;	}
 	sal_Bool IsAnyNoteAtEnd() const { return bFtnAtEnd || bEndnAtEnd; }
 	sal_Bool AreNotesAtEnd() const { return bFtnAtEnd && bEndnAtEnd; }

 	sal_Bool IsPageBreak( sal_Bool bAct ) const;
 	sal_Bool IsColBreak( sal_Bool bAct ) const;

     //Ist ein Keep zu beruecksichtigen (Breaks!)
     sal_Bool IsKeep( const SwAttrSet& rAttrs, bool bBreakCheck = false ) const;

     sal_Bool HasLockedFollow() const;

     sal_Bool HasParaSpaceAtPages( sal_Bool bSct ) const;

     /** method to determine the upper space hold by the frame

         OD 2004-03-12 #i11860# - add 3rd parameter <_bConsiderGrid> to get
         the upper space with and without considering the page grid
         (default value: <sal_True>)

         @author ?
     */
     SwTwips CalcUpperSpace( const SwBorderAttrs *pAttrs = NULL,
                             const SwFrm* pPr = NULL,
                             const bool _bConsiderGrid = true ) const;

     /** method to determine the upper space amount, which is considered for
         the previous frame and the page grid, if option 'Use former object
         positioning' is OFF

         OD 2004-03-18 #i11860#

         @author OD
     */
     SwTwips GetUpperSpaceAmountConsideredForPrevFrmAndPageGrid() const;

     /** calculation of lower space

         OD 2004-03-02 #106629#

         @author OD
     */
     SwTwips CalcLowerSpace( const SwBorderAttrs* _pAttrs = 0L ) const;

     /** calculation of the additional space to be considered, if flow frame
         is the last inside a table cell

         OD 2004-07-16 #i26250

         @author OD

         @param _pAttrs
         optional input parameter - border attributes of the flow frame.
         Used for optimization, if caller has already determined the border
         attributes.

         @return SwTwips
     */
     SwTwips CalcAddLowerSpaceAsLastInTableCell(
                                     const SwBorderAttrs* _pAttrs = 0L ) const;

     void CheckKeep();

 	void SetFtnLock( sal_Bool bNew ){ bFtnLock = bNew; }
 	sal_Bool IsFtnLock() const {	return bFtnLock; }
     void SetFlyLock( sal_Bool bNew ){ bFlyLock = bNew; }
     sal_Bool IsFlyLock() const {    return bFlyLock; }
 	void SetOwnFtnNum( sal_Bool bNew ){ bOwnFtnNum = bNew; }
 	sal_Bool IsOwnFtnNum() const {	return bOwnFtnNum; }
 	void SetCntntLock( sal_Bool bNew ){ bCntntLock = bNew; }
 	sal_Bool IsCntntLocked() const {	return bCntntLock; }

 	//casten einen Frm auf einen FlowFrm - wenns denn einer ist, sonst 0
 	//Diese Methoden muessen fuer neue Ableitungen geaendert werden!
 	static 		 SwFlowFrm *CastFlowFrm( SwFrm *pFrm );
 	static const SwFlowFrm *CastFlowFrm( const SwFrm *pFrm );
 };

 inline sal_Bool SwFlowFrm::IsFwdMoveAllowed()
 {
 	return rThis.GetIndPrev() != 0;
 }


 #endif
	/**************************************************************
	*
	* 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
	*
	* Unless required by applicable law or agreed to in writing,
	* software distributed under the License is distributed on an
	* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	* KIND, either express or implied. See the License for the
	* specific language governing permissions and limitations
	* under the License.
	*
	*************************************************************/


	#ifndef _FLOWFRM_HXX
	#define _FLOWFRM_HXX

	//Der FlowFrm gibt die Funktionalitaet fuer alle Frms vor, die fliessen und
	//die sich aufspalten koennen (wie CntntFrm oder TabFrm).
	//Teile der Funktionalitaet sind im FlowFrm implementiert, andere Teile werden
	//von den spezifischen Frms implementiert.
	//Der FlowFrm ist kein eigenstaender Frm, es kann also auch niemals eine
	//eigenstaendige Instanz vom FlowFrm existieren.
	//Der FlowFrm ist nicht einmal ein echter Frm. Die naheliegende Implementierung
	//waere ein FlowFrm der virtual vom SwFrm abgeleitet ist und direkt auf den
	//eigenen Instanzdaten arbeitet. Abgeleitete Klassen muessten sich
	//vom FlowFrm und (ueber mehrere Basisklassen weil der Klassenbaum sich direkt
	//vom SwFrm zu SwCntntFrm und zum SwLayoutFrm spaltet) virtual vom SwFrm
	//ableiten.
	//Leider entstehen dadurch - neben Problemen mit Compilern und Debuggern -
	//erhebliche zusaetzliche Kosten, die wir uns heutzutage IMHO nicht erlauben
	//koennen.
	//Ich greife deshalb auf eine andere Technik zurueck: Der FlowFrm hat eine
	//Referenz auf den SwFrm - der er genau betrachtet selbst ist - und ist mit
	//diesem befreundet. So kann der FlowFrm anstelle des this-Pointer mit der
	//Referenz auf den SwFrm arbeiten.

	//#include "frame.hxx" //fuer inlines

	class SwPageFrm;
	class SwRect;
	class SwBorderAttrs;
	class SwDoc;
	class SwNodeIndex;
	// --> OD 2005-03-04 #i44049#
	class SwObjectFormatterTxtFrm;
	// <--

	void MakeFrms( SwDoc *, const SwNodeIndex &, const SwNodeIndex & );

	class SwFlowFrm
	{
	//PrepareMake darf Locken/Unlocken (Robustheit)
	friend inline void PrepareLock ( SwFlowFrm * );
	friend inline void PrepareUnlock( SwFlowFrm * );
	friend inline void TableSplitRecalcLock( SwFlowFrm * );
	friend inline void TableSplitRecalcUnlock( SwFlowFrm * );
	// --> OD 2005-03-04 #i44049#
	friend class SwObjectFormatterTxtFrm;
	// <--

	//TblSel darf das Follow-Bit zuruecksetzen.
	friend inline void UnsetFollow( SwFlowFrm *pFlow );

	friend void MakeFrms( SwDoc *, const SwNodeIndex &, const SwNodeIndex & );

	friend class SwNode2LayImpl;

	SwFrm &rThis;

	//Hilfsfunktionen fuer MoveSubTree()
	static SwLayoutFrm CutTree( SwFrm );
	static sal_Bool PasteTree( SwFrm , SwLayoutFrm , SwFrm , SwFrm );

	//Wird fuer das Zusammenspiel von _GetPrevxxx und MoveBwd gebraucht, damit
	//mehrere Blaetter gleichzeitig uebersprungen werden koennen.
	//Wird auch vom MoveBwd des TabFrm ausgewertet!
	static sal_Bool bMoveBwdJump;

	/** helper method to determine previous frame for calculation of the
	upper space

	OD 2004-03-10 #i11860#

	@param _pProposedPrevFrm
	optional input parameter - pointer to frame, which should be used
	instead of the direct previous frame.

	@author OD
	*/
	const SwFrm* _GetPrevFrmForUpperSpaceCalc( const SwFrm* _pProposedPrevFrm = 0L ) const;

	/** method to detemine the upper space amount, which is considered for
	the previous frame

	OD 2004-03-11 #i11860#

	@author OD
	*/
	SwTwips _GetUpperSpaceAmountConsideredForPrevFrm() const;

	/** method to detemine the upper space amount, which is considered for
	the page grid

	OD 2004-03-12 #i11860#

	@author OD
	*/
	SwTwips _GetUpperSpaceAmountConsideredForPageGrid(
	const SwTwips _nUpperSpaceWithoutGrid ) const;

	protected:

	SwFlowFrm *pFollow;

	sal_Bool bIsFollow :1; //Ist's ein Follow
	sal_Bool bLockJoin :1; //Join (und damit deleten) verboten wenn sal_True!
	sal_Bool bUndersized:1; // wir sind kleiner als gewuenscht
	sal_Bool bFtnAtEnd :1; // For sectionfrms only: footnotes at the end of section
	sal_Bool bEndnAtEnd :1; // " " " : endnotes at the end of section
	sal_Bool bCntntLock :1; // " " " : content locked
	sal_Bool bOwnFtnNum :1; // " " " : special numbering of footnotes
	sal_Bool bFtnLock :1; // " " " : ftn, don't leave this section bwd
	sal_Bool bFlyLock :1; // Stop positioning of at-character flyframes

	//Prueft ob Vorwaertsfluss noch Sinn macht Endloswanderschaften (unterbinden)
	inline sal_Bool IsFwdMoveAllowed();
	// --> OD 2005-03-08 #i44049# - method <CalcCntnt(..)> has to check this property.
	friend void CalcCntnt( SwLayoutFrm *pLay, bool bNoColl, bool bNoCalcFollow );
	// <--
	sal_Bool IsKeepFwdMoveAllowed(); //Wie oben, Move fuer Keep.

	//Prueft ob ein Obj das Umlauf wuenscht ueberlappt.
	//eine Null bedeutet, kein Objekt ueberlappt,
	// 1 heisst, Objekte, die am FlowFrm selbst verankert sind, ueberlappen
	// 2 heisst, Objekte, die woanders verankert sind, ueberlappen
	// 3 heistt, beiderlei verankerte Objekte ueberlappen
	sal_uInt8 BwdMoveNecessary( const SwPageFrm *pPage, const SwRect &rRect );

	void LockJoin() { bLockJoin = sal_True; }
	void UnlockJoin() { bLockJoin = sal_False; }

	sal_Bool CheckMoveFwd( sal_Bool &rbMakePage, sal_Bool bKeep, sal_Bool bMovedBwd );
	sal_Bool MoveFwd( sal_Bool bMakePage, sal_Bool bPageBreak, sal_Bool bMoveAlways = sal_False );
	virtual sal_Bool ShouldBwdMoved( SwLayoutFrm *pNewUpper, sal_Bool bHead, sal_Bool &rReformat )=0;
	sal_Bool MoveBwd( sal_Bool &rbReformat );

	public:
	SwFlowFrm( SwFrm &rFrm );

	const SwFrm *GetFrm() const { return &rThis; }
	SwFrm *GetFrm() { return &rThis; }

	static sal_Bool IsMoveBwdJump() { return bMoveBwdJump; }
	static void SetMoveBwdJump( sal_Bool bNew ){ bMoveBwdJump = bNew; }

	inline void SetUndersized( const sal_Bool bNew ) { bUndersized = bNew; }
	inline sal_Bool IsUndersized() const { return bUndersized; }

	sal_Bool IsPrevObjMove() const;

	//Die Kette mit minimalen Operationen und Benachrichtigungen unter den
	//neuen Parent Moven.
	void MoveSubTree( SwLayoutFrm* pParent, SwFrm* pSibling = 0 );

	sal_Bool HasFollow() const { return pFollow ? sal_True : sal_False; }
	sal_Bool IsFollow() const { return bIsFollow; }
	inline void _SetIsFollow( sal_Bool bSet ) { bIsFollow = bSet; }
	const SwFlowFrm *GetFollow() const { return pFollow; }
	SwFlowFrm *GetFollow() { return pFollow; }
	sal_Bool IsAnFollow( const SwFlowFrm *pFlow ) const;
	inline void SetFollow( SwFlowFrm *pNew ) { pFollow = pNew; }

	sal_Bool IsJoinLocked() const { return bLockJoin; }
	sal_Bool IsAnyJoinLocked() const { return bLockJoin \|\| HasLockedFollow(); }
	sal_Bool IsFtnAtEnd() const { return bFtnAtEnd; }
	sal_Bool IsEndnAtEnd() const { return bEndnAtEnd; }
	sal_Bool IsAnyNoteAtEnd() const { return bFtnAtEnd \|\| bEndnAtEnd; }
	sal_Bool AreNotesAtEnd() const { return bFtnAtEnd && bEndnAtEnd; }

	sal_Bool IsPageBreak( sal_Bool bAct ) const;
	sal_Bool IsColBreak( sal_Bool bAct ) const;

	//Ist ein Keep zu beruecksichtigen (Breaks!)
	sal_Bool IsKeep( const SwAttrSet& rAttrs, bool bBreakCheck = false ) const;

	sal_Bool HasLockedFollow() const;

	sal_Bool HasParaSpaceAtPages( sal_Bool bSct ) const;

	/** method to determine the upper space hold by the frame

	OD 2004-03-12 #i11860# - add 3rd parameter <_bConsiderGrid> to get
	the upper space with and without considering the page grid
	(default value: <sal_True>)

	@author ?
	*/
	SwTwips CalcUpperSpace( const SwBorderAttrs *pAttrs = NULL,
	const SwFrm* pPr = NULL,
	const bool _bConsiderGrid = true ) const;

	/** method to determine the upper space amount, which is considered for
	the previous frame and the page grid, if option 'Use former object
	positioning' is OFF

	OD 2004-03-18 #i11860#

	@author OD
	*/
	SwTwips GetUpperSpaceAmountConsideredForPrevFrmAndPageGrid() const;

	/** calculation of lower space

	OD 2004-03-02 #106629#

	@author OD
	*/
	SwTwips CalcLowerSpace( const SwBorderAttrs* _pAttrs = 0L ) const;

	/** calculation of the additional space to be considered, if flow frame
	is the last inside a table cell

	OD 2004-07-16 #i26250

	@author OD

	@param _pAttrs
	optional input parameter - border attributes of the flow frame.
	Used for optimization, if caller has already determined the border
	attributes.

	@return SwTwips
	*/
	SwTwips CalcAddLowerSpaceAsLastInTableCell(
	const SwBorderAttrs* _pAttrs = 0L ) const;

	void CheckKeep();

	void SetFtnLock( sal_Bool bNew ){ bFtnLock = bNew; }
	sal_Bool IsFtnLock() const { return bFtnLock; }
	void SetFlyLock( sal_Bool bNew ){ bFlyLock = bNew; }
	sal_Bool IsFlyLock() const { return bFlyLock; }
	void SetOwnFtnNum( sal_Bool bNew ){ bOwnFtnNum = bNew; }
	sal_Bool IsOwnFtnNum() const { return bOwnFtnNum; }
	void SetCntntLock( sal_Bool bNew ){ bCntntLock = bNew; }
	sal_Bool IsCntntLocked() const { return bCntntLock; }

	//casten einen Frm auf einen FlowFrm - wenns denn einer ist, sonst 0
	//Diese Methoden muessen fuer neue Ableitungen geaendert werden!
	static SwFlowFrm CastFlowFrm( SwFrm pFrm );
	static const SwFlowFrm CastFlowFrm( const SwFrm pFrm );
	};

	inline sal_Bool SwFlowFrm::IsFwdMoveAllowed()
	{
	return rThis.GetIndPrev() != 0;
	}


	#endif