diff options
Diffstat (limited to 'sw/inc/anchoredobject.hxx')
| -rw-r--r-- | sw/inc/anchoredobject.hxx | 112 |
1 files changed, 23 insertions, 89 deletions
diff --git a/sw/inc/anchoredobject.hxx b/sw/inc/anchoredobject.hxx index c9f53e51f069..ce5ef72c4445 100644 --- a/sw/inc/anchoredobject.hxx +++ b/sw/inc/anchoredobject.hxx @@ -1,3 +1,4 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. @@ -34,19 +35,16 @@ class SdrObject; class SwFrm; class SwLayoutFrm; -// --> OD 2004-07-14 #117380# class SwTxtFrm; -// <-- -// --> OD 2004-06-30 #i28701# + class SwPageFrm; class SwObjPositioningInProgress; -// <-- + class SwFrmFmt; class SwFmtAnchor; /** wrapper class for the positioning of Writer fly frames and drawing objects - OD 2004-03-22 #i26791# Purpose of this class is to provide a unified interface for the positioning of Writer fly frames (derived classes of <SwFlyFrm>) and of drawing objects (derived classes of <SwDrawFrm>). @@ -60,10 +58,9 @@ class SW_DLLPUBLIC SwAnchoredObject SdrObject* mpDrawObj; // frame the object is anchored at SwFrm* mpAnchorFrm; - // --> OD 2004-06-30 #i28701# - page frame the object is registered at + // #i28701 - page frame the object is registered at // note: no page frame for as-character anchored objects SwPageFrm* mpPageFrm; - // <-- // current relative position (relative to anchor position of anchor frame) Point maRelPos; @@ -85,34 +82,32 @@ class SW_DLLPUBLIC SwAnchoredObject // a following layout frame in the text flow. const SwLayoutFrm* mpVertPosOrientFrm; - // --> OD 2004-06-30 #i28701# - boolean, indicating that the object + // i#i28701 boolean, indicating that the object // positioning algorithm is in progress. bool mbPositioningInProgress; - // <-- - // --> OD 2004-06-29 #i28701# - Booleans needed for the layout process. + // Booleans needed for the layout process. // Values only of relevance for to-paragraph and to-character anchored // floating screen object, for whose the 'straight-forward positioning // process are applied // Otherwise value of <mbConsiderForTextWrap> is treated as <true>, // value of <mbPositionLocked> is treated as <false> and // value of <mbRestartLayoutProcess> is treated as <false>. - // --> OD 2004-10-22 #i35911# - add boolean <mbClearEnvironment> + // i#35911 - add boolean <mbClearEnvironment> // Indicates that due to its position and wrapping style its layout // environment is cleared - all content is moved forward. // Treated as <false>, if not the 'straight-forward positioning process" // is applied. bool mbConsiderForTextWrap; bool mbPositionLocked; - // --> OD 2005-01-10 #i40147# - boolean needed to keep position of + // boolean needed to keep position of // anchored object locked due to special object positioning for sections. bool mbKeepPositionLockedForSection; - // <-- + bool mbRestartLayoutProcess; bool mbClearedEnvironment; - // <-- - // --> OD 2004-08-25 #i3317# - boolean, indicating that temporarly + // i#i3317 - boolean, indicating that temporarly // the wrapping style influence of the anchored object has to be // considered during its positioning. // This boolean is used, if compatibility option 'Consider wrapping style @@ -122,13 +117,10 @@ class SW_DLLPUBLIC SwAnchoredObject // The boolean is reset to <false>, when the layout process for a // page frame starts - see class <NotifyLayoutOfPageInProgress>. bool mbTmpConsiderWrapInfluence; - // <-- - // --> OD 2006-06-21 #i68520# mutable SwRect maObjRectWithSpaces; mutable bool mbObjRectWithSpacesValid; mutable SwRect maLastObjRect; - // <-- /** method to indicate, that positioning of anchored object is in progress @@ -145,12 +137,10 @@ class SW_DLLPUBLIC SwAnchoredObject /** check anchor character rectangle - OD 2004-03-25 #i26791# helper method for method <CheckCharRectAndTopOfLine()> For to-character anchored Writer fly frames the member <maLastCharRect> is updated. This is checked for change and depending on the applied positioning, it's decided, if the Writer fly frame has to be invalidated. - OD 2004-07-14 #117380# improvement - add second parameter <_rAnchorCharFrm> @author OD @@ -167,13 +157,10 @@ class SW_DLLPUBLIC SwAnchoredObject /** check top of line - OD 2004-03-25 #i26791# helper method for method <CheckCharRectAndTopOfLine()> For to-character anchored Writer fly frames the member <mnLastTopOfLine> is updated. This is checked for change and depending on the applied positioning, it's decided, if the Writer fly frame has to be invalidated. - OD 2004-07-14 #117380# - improvement - add second parameter <_rAnchorCharFrm> @author OD @@ -187,7 +174,6 @@ class SW_DLLPUBLIC SwAnchoredObject void _CheckTopOfLine( const SwFmtAnchor& _rAnch, const SwTxtFrm& _rAnchorCharFrm ); - // --> OD 2005-03-30 #120729# - needed for the hotfix // method <lcl_HideObj(..)> sets needed data structure values for the // object positioning friend bool lcl_HideObj( const SwTxtFrm& _rFrm, @@ -203,8 +189,6 @@ class SW_DLLPUBLIC SwAnchoredObject /** method to assure that anchored object is registered at the correct page frame - OD 2004-07-02 #i28701# - @author OD */ virtual void RegisterAtCorrectPage() = 0; @@ -218,8 +202,6 @@ class SW_DLLPUBLIC SwAnchoredObject /** method to determine, if other anchored objects, also attached at to the anchor frame, have to consider its wrap influence. - // --> OD 2005-02-22 #i43255# - @author OD */ bool ConsiderObjWrapInfluenceOfOtherObjs() const; @@ -227,20 +209,14 @@ class SW_DLLPUBLIC SwAnchoredObject /** method to apply temporary consideration of wrapping style influence to the anchored objects, which are anchored at the same anchor frame - OD 2006-07-24 #b6449874# - @author OD */ void SetTmpConsiderWrapInfluenceOfOtherObjs( const bool bTmpConsiderWrapInfluence ); - // --> OD 2006-08-10 #i68520# virtual bool _SetObjTop( const SwTwips _nTop) = 0; virtual bool _SetObjLeft( const SwTwips _nLeft) = 0; - // <-- - // --> OD 2006-10-05 #i70122# virtual const SwRect GetObjBoundRect() const = 0; - // <-- public: TYPEINFO(); @@ -257,7 +233,6 @@ class SW_DLLPUBLIC SwAnchoredObject void ChgAnchorFrm( SwFrm* _pNewAnchorFrm ); /** determine anchor frame containing the anchor position - OD 2004-10-08 #i26945# the anchor frame, which is determined, is <mpAnchorFrm> for an at-page, at-frame or at-paragraph anchored object and the anchor character frame for an at-character and as-character @@ -267,17 +242,13 @@ class SW_DLLPUBLIC SwAnchoredObject */ SwFrm* GetAnchorFrmContainingAnchPos(); - // --> OD 2004-06-30 #i28701# - accessors to member <mpPageFrm> SwPageFrm* GetPageFrm(); const SwPageFrm* GetPageFrm() const; void SetPageFrm( SwPageFrm* _pNewPageFrm ); - // <-- /** method to determine the page frame, on which the 'anchor' of the given anchored object is. - OD 2004-07-02 #i28701# - OD 2004-09-23 #i33751#, #i34060# Adjust meaning of method and thus its name: If the anchored object or its anchor isn't correctly inserted in the layout, no page frame can be found. Thus, the return type changed to be a pointer and can @@ -297,8 +268,6 @@ class SW_DLLPUBLIC SwAnchoredObject /** get frame, which contains the anchor character, if the object is anchored at-character or as-character. - OD 2004-10-04 #i26945# - @author OD @return SwTxtFrm* @@ -313,22 +282,18 @@ class SW_DLLPUBLIC SwAnchoredObject { return mpVertPosOrientFrm; } - // --> OD 2004-11-29 #115759# - method to clear member <mpVertPosOrientFrm> + // method to clear member <mpVertPosOrientFrm> inline void ClearVertPosOrientFrm() { mpVertPosOrientFrm = 0L; } - // <-- /** check anchor character rectangle and top of line - OD 2004-03-25 #i26791# For to-character anchored Writer fly frames the members <maLastCharRect> and <maLastTopOfLine> are updated. These are checked for change and depending on the applied positioning, it's decided, if the Writer fly frame has to be invalidated. - OD 2004-07-15 #117380# - add parameter <_bCheckForParaPorInf>, default value <true> @author OD @@ -347,13 +312,10 @@ class SW_DLLPUBLIC SwAnchoredObject // accessor to member <nmLastTopOfLine> SwTwips GetLastTopOfLine() const; - // OD 2004-05-18 #i28701# - follow-up of #i22341# void AddLastTopOfLineY( SwTwips _nDiff ); /** reset members <maLastCharRect> and <mnLastTopOfLine> - OD 2004-06-29 #i27801# - @author OD */ void ClearCharRectAndTopOfLine(); @@ -376,8 +338,6 @@ class SW_DLLPUBLIC SwAnchoredObject /** method to determine, if invalidation of position is allowed - OD 2004-07-01 #i28701# - @author OD */ bool InvalidationOfPosAllowed() const; @@ -392,16 +352,12 @@ class SW_DLLPUBLIC SwAnchoredObject objects, for whose the wrapping style influence has to be considered on the object positioning. - OD 2004-06-30 #i28701# - @author OD */ void InvalidateObjPosForConsiderWrapInfluence( const bool _bNotifyBackgrd ); /** method to trigger notification of 'background' - OD 2004-07-01 #i28701# - @author OD */ virtual void NotifyBackground( SwPageFrm* _pPageFrm, @@ -419,19 +375,15 @@ class SW_DLLPUBLIC SwAnchoredObject // accessors to the object area and its position virtual const SwRect GetObjRect() const = 0; - // --> OD 2006-08-10 #i68520# + void SetObjTop( const SwTwips _nTop); void SetObjLeft( const SwTwips _nLeft); - // <-- /** method update layout direction the layout direction, the anchored object is assigned to - OD 2004-07-27 #i31698# method has typically to be called, if the anchored object gets its anchor frame assigned and if the anchor frame changes its layout direction - OD 2006-03-17 #i62875# - made virtual, because it's needed to be overloaded by <SwAnchoredDrawObject> @author OD */ @@ -439,24 +391,18 @@ class SW_DLLPUBLIC SwAnchoredObject /** method to determine object area inclusive its spacing - OD 2004-06-30 #i28701# - OD 2006-08-10 #i68520# - return constant reference - @author OD */ const SwRect& GetObjRectWithSpaces() const; - // --> OD 2006-08-10 #i68520# inline void InvalidateObjRectWithSpaces() const { mbObjRectWithSpacesValid = false; } - // <-- /** method to determine, if wrapping style influence of the anchored object has to be considered on the object positioning - OD 2004-06-30 #i28701# Note: result of this method also decides, if the boolean for the layout process are of relevance. @@ -464,7 +410,7 @@ class SW_DLLPUBLIC SwAnchoredObject */ bool ConsiderObjWrapInfluenceOnObjPos() const; - // --> OD 2004-06-29 #i28701# - accessors to booleans for layout process + // accessors to booleans for layout process bool ConsiderForTextWrap() const; void SetConsiderForTextWrap( const bool _bConsiderForTextWrap ); bool PositionLocked() const; @@ -479,19 +425,19 @@ class SW_DLLPUBLIC SwAnchoredObject mbPositionLocked = false; } } - // --> OD 2005-01-10 #i40147# + inline void SetKeepPosLocked( const bool _bKeepPosLocked ) { mbKeepPositionLockedForSection = _bKeepPosLocked; } - // <-- + bool RestartLayoutProcess() const; void SetRestartLayoutProcess( const bool _bRestartLayoutProcess ); - // --> OD 2004-10-22 #i35911# - accessors for <mbClearedEnvironment> + // accessors for <mbClearedEnvironment> bool ClearedEnvironment() const; void SetClearedEnvironment( const bool _bClearedEnvironment ); - // <-- - // --> OD 2005-03-03 #i43913# - reset booleans for layout process + + // reset booleans for layout process inline void ResetLayoutProcessBools() { mbPositioningInProgress = false; @@ -502,20 +448,16 @@ class SW_DLLPUBLIC SwAnchoredObject mbClearedEnvironment = false; mbTmpConsiderWrapInfluence = false; } - // <-- /** method to determine, if due to anchored object size and wrapping style, its layout environment is cleared. - OD 2004-10-22 #i35911# - @author OD */ bool HasClearedEnvironment() const; /** method to update anchored object in the <SwSortedObjs> lists - OD 2004-07-01 #i28701# Method is not proposed to be called during a layout process is running. It has been used on the change of the anchored object attributes, which belongs the sort criteria of <SwSortedObjs>. @@ -530,7 +472,6 @@ class SW_DLLPUBLIC SwAnchoredObject /** method to determine, if a format on the anchored object is possible - OD 2004-07-23 #i28701# A format isn't possible, if anchored object is in an invisible layer. Note: method is virtual to refine the conditions for the sub-classes. @@ -538,15 +479,13 @@ class SW_DLLPUBLIC SwAnchoredObject */ virtual bool IsFormatPossible() const; - // --> OD 2004-08-25 #i3317# - accessors to member <mbTmpConsiderWrapInfluence> + // accessors to member <mbTmpConsiderWrapInfluence> void SetTmpConsiderWrapInfluence( const bool _bTmpConsiderWrapInfluence ); bool IsTmpConsiderWrapInfluence() const; - // <-- /** method to determine, if the anchored object is overlapping with a previous column - OD 2004-08-25 #i3317# overlapping with a previous column means, that the object overlaps with a column, which is a previous one of the column its anchor frame is in. @@ -559,7 +498,6 @@ class SW_DLLPUBLIC SwAnchoredObject /** method to determine position of anchored object relative to anchor frame - OD 2005-01-06 #i30669# Usage: Needed layout information for WW8 export @author OD @@ -571,10 +509,8 @@ class SW_DLLPUBLIC SwAnchoredObject /** method to determine position of anchored object relative to page frame - OD 2005-01-06 #i30669# Usage: Needed layout information for WW8 export - OD 2005-01-27 #i33818# - add parameters <_bFollowTextFlow> and - <_obRelToTableCell> + If <_bFollowTextFlow> is set and object is anchored inside table, the position relative to the table cell is determined. Output parameter <_obRelToTableCell> reflects this situation @@ -597,7 +533,6 @@ class SW_DLLPUBLIC SwAnchoredObject /** method to determine position of anchored object relative to anchor character - OD 2005-01-06 #i30669# Usage: Needed layout information for WW8 export @author OD @@ -609,7 +544,6 @@ class SW_DLLPUBLIC SwAnchoredObject /** method to determine position of anchored object relative to top of line - OD 2005-01-06 #i30669# Usage: Needed layout information for WW8 export @author OD @@ -620,18 +554,16 @@ class SW_DLLPUBLIC SwAnchoredObject }; // ============================================================================ -// OD 2004-04-13 #i26791#, #i28701# // helper class for notify that positioning of an anchored object is in progress // ============================================================================ class SwObjPositioningInProgress { private: SwAnchoredObject* mpAnchoredObj; - // --> OD 2005-08-09 #i52904# - introduce boolean indicating old state + // boolean indicating old state // of anchored object regarding positioning in progress in order to // consider nested usage of class <SwObjPositioningInProgress> bool mbOldObjPositioningInProgress; - // <-- public: SwObjPositioningInProgress( SdrObject& _rSdrObj ); @@ -640,3 +572,5 @@ class SwObjPositioningInProgress }; #endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |