| /************************************************************** |
| * |
| * 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 _ANCHOREDOBJECT_HXX |
| #define _ANCHOREDOBJECT_HXX |
| |
| #include <tools/rtti.hxx> |
| #include <swtypes.hxx> |
| #include <swrect.hxx> |
| |
| 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>). |
| |
| @author OD |
| */ |
| class SW_DLLPUBLIC SwAnchoredObject |
| { |
| private: |
| // drawing object representing the anchored object in the drawing layer |
| SdrObject* mpDrawObj; |
| // frame the object is anchored at |
| SwFrm* mpAnchorFrm; |
| // --> OD 2004-06-30 #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; |
| |
| // for to-character anchored objects: |
| // Last known anchor character retangle. |
| // Used to decide, if invalidation has to been performed, if anchor position |
| // has changed, and used to position object. |
| SwRect maLastCharRect; |
| |
| // for to-character anchored objects: |
| // Last known top of line, in which the anchor character is in. |
| // Used to decide, if invalidation has to been performed, if anchor position |
| // has changed, and used to position object. |
| SwTwips mnLastTopOfLine; |
| |
| // for to-paragraph and to-character anchored objects: |
| // Layout frame vertical position is orient at - typically its the upper |
| // of the anchor frame, but it could also by the upper of a follow or |
| // a following layout frame in the text flow. |
| const SwLayoutFrm* mpVertPosOrientFrm; |
| |
| // --> OD 2004-06-30 #i28701# - boolean, indicating that the object |
| // positioning algorithm is in progress. |
| bool mbPositioningInProgress; |
| // <-- |
| |
| // --> OD 2004-06-29 #i28701# - 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> |
| // 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 |
| // 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 |
| // 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 |
| // influence on object positioning' is OFF and a positioning loop is |
| // detected in method <SwFlyAtCntFrm::MakeAll()> or method |
| // <SwAnchoredDrawObject::_MakeObjPosAnchoredAtPara()>. |
| // 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 |
| |
| note: method is implemented empty |
| |
| @author OD |
| */ |
| friend class SwObjPositioningInProgress; |
| inline void SetPositioningInProgress( const bool _bPosInProgress ) |
| { |
| mbPositioningInProgress = _bPosInProgress; |
| } |
| |
| |
| /** 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 |
| |
| @param _rAnch |
| input parameter - reference to anchor position |
| |
| @param _rAnchorCharFrm |
| input parameter - reference to the text frame containing the anchor |
| character. |
| */ |
| void _CheckCharRect( const SwFmtAnchor& _rAnch, |
| const SwTxtFrm& _rAnchorCharFrm ); |
| |
| /** 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 |
| |
| @param _rAnch |
| input parameter - reference to anchor position |
| |
| @param _rAnchorCharFrm |
| input parameter - reference to the text frame containing the anchor |
| character. |
| */ |
| 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, |
| const RndStdIds _eAnchorType, |
| const xub_StrLen _nObjAnchorPos, |
| SwAnchoredObject* _pAnchoredObj ); |
| // <-- |
| protected: |
| SwAnchoredObject(); |
| |
| void SetVertPosOrientFrm( const SwLayoutFrm& _rVertPosOrientFrm ); |
| |
| /** method to assure that anchored object is registered at the correct |
| page frame |
| |
| OD 2004-07-02 #i28701# |
| |
| @author OD |
| */ |
| virtual void RegisterAtCorrectPage() = 0; |
| |
| /** method to indicate, that anchored object is attached to a anchor frame |
| |
| @author OD |
| */ |
| virtual void ObjectAttachedToAnchorFrame(); |
| |
| /** 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; |
| |
| /** 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(); |
| |
| virtual ~SwAnchoredObject(); |
| |
| // accessors to member <mpDrawObj> |
| void SetDrawObj( SdrObject& _rDrawObj ); |
| const SdrObject* GetDrawObj() const; |
| SdrObject* DrawObj(); |
| |
| // accessors to member <mpAnchorFrm> |
| const SwFrm* GetAnchorFrm() const; |
| SwFrm* AnchorFrm(); |
| 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 |
| anchored object. |
| |
| @author OD |
| */ |
| 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 |
| be NULL. |
| |
| @author OD |
| |
| @param _rAnchoredObj |
| input parameter - anchored object, for which the page frame of its |
| 'anchor' has to be determined. |
| |
| @return SwPageFrm& |
| page frame, the 'anchor' of the given anchored object is on |
| */ |
| SwPageFrm* FindPageFrmOfAnchor(); |
| |
| /** 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* |
| text frame containing the anchor character. It's NULL, if the object |
| isn't anchored at-character resp. as-character. |
| */ |
| SwTxtFrm* FindAnchorCharFrm(); |
| |
| // accessors to data of position calculation: |
| // frame vertical position is orient at |
| inline const SwLayoutFrm* GetVertPosOrientFrm() const |
| { |
| return mpVertPosOrientFrm; |
| } |
| // --> OD 2004-11-29 #115759# - 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 |
| |
| @param _bCheckForParaPorInf |
| input parameter - boolean indicating, if check on paragraph portion |
| information has to be done. |
| */ |
| void CheckCharRectAndTopOfLine( const bool _bCheckForParaPorInf = true ); |
| |
| // accessors to member <maLastCharRect> |
| const SwRect& GetLastCharRect() const; |
| SwTwips GetRelCharX( const SwFrm* pFrm ) const; |
| SwTwips GetRelCharY( const SwFrm* pFrm ) const; |
| void AddLastCharY( long nDiff ); |
| void ResetLastCharRectHeight(); |
| |
| // 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(); |
| |
| /** method to determine position for the object and set the position |
| at the object |
| |
| @author OD |
| */ |
| virtual void MakeObjPos() = 0; |
| |
| /** is positioning of anchored object in progress |
| |
| @author OD |
| */ |
| inline bool IsPositioningInProgress() const |
| { |
| return mbPositioningInProgress; |
| } |
| |
| /** method to determine, if invalidation of position is allowed |
| |
| OD 2004-07-01 #i28701# |
| |
| @author OD |
| */ |
| bool InvalidationOfPosAllowed() const; |
| |
| /** method to invalidate position of the anchored object |
| |
| @author OD |
| */ |
| virtual void InvalidateObjPos() = 0; |
| |
| /** method to perform necessary invalidations for the positioning of |
| 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, |
| const SwRect& _rRect, |
| PrepareHint _eHint ) = 0; |
| |
| // accessors to the current relative position (relative to anchor |
| // position of anchor frame) |
| const Point GetCurrRelPos() const; |
| void SetCurrRelPos( Point _aRelPos ); |
| |
| // accessors to the format |
| virtual SwFrmFmt& GetFrmFmt() = 0; |
| virtual const SwFrmFmt& GetFrmFmt() const = 0; |
| |
| // 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 |
| */ |
| virtual void UpdateLayoutDir(); |
| |
| /** 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. |
| |
| @author OD |
| */ |
| bool ConsiderObjWrapInfluenceOnObjPos() const; |
| |
| // --> OD 2004-06-29 #i28701# - accessors to booleans for layout process |
| bool ConsiderForTextWrap() const; |
| void SetConsiderForTextWrap( const bool _bConsiderForTextWrap ); |
| bool PositionLocked() const; |
| inline void LockPosition() |
| { |
| mbPositionLocked = true; |
| } |
| inline void UnlockPosition() |
| { |
| if ( !mbKeepPositionLockedForSection ) |
| { |
| 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> |
| bool ClearedEnvironment() const; |
| void SetClearedEnvironment( const bool _bClearedEnvironment ); |
| // <-- |
| // --> OD 2005-03-03 #i43913# - reset booleans for layout process |
| inline void ResetLayoutProcessBools() |
| { |
| mbPositioningInProgress = false; |
| mbConsiderForTextWrap = false; |
| mbPositionLocked = false; |
| mbKeepPositionLockedForSection = false; |
| mbRestartLayoutProcess = false; |
| 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>. |
| If document compatibility option 'Consider wrapping style influence |
| on object positioning' is ON, additionally all anchored objects |
| at the anchor frame and all following anchored objects on the page |
| frame are invalidated. |
| |
| @author OD |
| */ |
| void UpdateObjInSortedList(); |
| |
| /** 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. |
| |
| @author OD |
| */ |
| virtual bool IsFormatPossible() const; |
| |
| // --> OD 2004-08-25 #i3317# - 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. |
| Only applied for at-paragraph and at-character anchored objects. |
| |
| @author OD |
| */ |
| bool OverlapsPrevColumn() const; |
| |
| /** 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 |
| |
| @return Point - determined relative position |
| */ |
| Point GetRelPosToAnchorFrm() const; |
| |
| /** 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 |
| |
| @author OD |
| |
| @param _bFollowTextFlow |
| input parameter - boolean indicating, if the anchored object has to |
| follow the text flow. |
| |
| @param _obRelToTableCell |
| output parameter - boolean indicating, the determine position is |
| relative to the table cell |
| |
| @return Point - determined relative position |
| */ |
| Point GetRelPosToPageFrm( const bool _bFollowTextFlow, |
| bool& _obRelToTableCell ) const; |
| |
| /** 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 |
| |
| @return Point - determined relative position |
| */ |
| Point GetRelPosToChar() const; |
| |
| /** 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 |
| |
| @return Point - determined relative position |
| */ |
| Point GetRelPosToLine() const; |
| }; |
| |
| // ============================================================================ |
| // 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 |
| // of anchored object regarding positioning in progress in order to |
| // consider nested usage of class <SwObjPositioningInProgress> |
| bool mbOldObjPositioningInProgress; |
| // <-- |
| |
| public: |
| SwObjPositioningInProgress( SdrObject& _rSdrObj ); |
| SwObjPositioningInProgress( SwAnchoredObject& _rAnchoredObj ); |
| ~SwObjPositioningInProgress(); |
| }; |
| |
| #endif |
