LibreOffice Module sw (master)  1
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
SwFlyFrameFormat Class Referencefinal

#include <frmfmt.hxx>

Inheritance diagram for SwFlyFrameFormat:
[legend]
Collaboration diagram for SwFlyFrameFormat:
[legend]

Public Member Functions

virtual ~SwFlyFrameFormat () override
 
virtual void MakeFrames () override
 Creates the views. More...
 
SwFlyFrameGetFrame (const Point *pDocPos=nullptr) const
 
SwAnchoredObjectGetAnchoredObj () const
 
virtual Graphic MakeGraphic (ImageMap *pMap=nullptr) override
 
virtual bool GetInfo (SfxPoolItem &rInfo) const override
 
OUString GetObjTitle () const
 
void SetObjTitle (const OUString &rTitle, bool bBroadcast=false)
 
OUString GetObjDescription () const
 
void SetObjDescription (const OUString &rDescription, bool bBroadcast=false)
 
virtual bool IsBackgroundTransparent () const override
 SwFlyFrameFormat::IsBackgroundTransparent. More...
 
bool IsBackgroundBrushInherited () const
 SwFlyFrameFormat::IsBackgroundBrushInherited. More...
 
const PointGetLastFlyFramePrtRectPos () const
 
void SetLastFlyFramePrtRectPos (const Point &rPoint)
 
SwFlyDrawContactGetOrCreateContact ()
 
- Public Member Functions inherited from SwFrameFormat
virtual ~SwFrameFormat () override
 
 SwFrameFormat (SwFrameFormat const &)=default
 
 SwFrameFormat (SwFrameFormat &&)=default
 
SwFrameFormatoperator= (SwFrameFormat const &)=default
 
SwFrameFormatoperator= (SwFrameFormat &&)=default
 
virtual void DelFrames ()
 Destroys all Frames in aDepend (Frames are identified via dynamic_cast). More...
 
IMapObjectGetIMapObject (const Point &rPoint, const SwFlyFrame *pFly=nullptr) const
 
SwRect FindLayoutRect (const bool bPrtArea=false, const Point *pPoint=nullptr) const
 
SdrObjectFindSdrObject ()
 
const SdrObjectFindSdrObject () const
 
SdrObjectFindRealSdrObject ()
 
const SdrObjectFindRealSdrObject () const
 
bool IsLowerOf (const SwFrameFormat &rFormat) const
 
virtual SwFrameFormat::tLayoutDir GetLayoutDir () const
 
virtual void SetLayoutDir (const SwFrameFormat::tLayoutDir _eLayoutDir)
 
virtual sal_Int16 GetPositionLayoutDir () const
 
virtual void SetPositionLayoutDir (const sal_Int16 _nPositionLayoutDir)
 
virtual OUString GetDescription () const
 
SAL_DLLPRIVATE css::uno::WeakReference< css::uno::XInterface > const & GetXObject () const
 
SAL_DLLPRIVATE void SetXObject (css::uno::Reference< css::uno::XInterface > const &xObject)
 
void RegisterToFormat (SwFormat &rFormat)
 
virtual drawinglayer::attribute::SdrAllFillAttributesHelperPtr getSdrAllFillAttributesHelper () const override
 
virtual bool supportsFullDrawingLayerFillAttributeSet () const override
 
void dumpAsXml (xmlTextWriterPtr pWriter) const
 
virtual void SetName (const OUString &rNewName, bool bBroadcast=false) override
 
- Public Member Functions inherited from SwFormat
virtual ~SwFormat () override
 
SwFormatoperator= (const SwFormat &)
 
sal_uInt16 Which () const
 for Querying of Writer-functions. More...
 
void CopyAttrs (const SwFormat &)
 Copy attributes even among documents. More...
 
void DelDiffs (const SfxItemSet &rSet)
 Delete all attributes that are not in rFormat. More...
 
void DelDiffs (const SwFormat &rFormat)
 
bool SetDerivedFrom (SwFormat *pDerivedFrom=nullptr)
 0 is Default. More...
 
const SfxPoolItemGetFormatAttr (sal_uInt16 nWhich, bool bInParents=true) const
 If bInParents is FALSE, search only in this format for attribute. More...
 
template<class T >
const T & GetFormatAttr (TypedWhichId< T > nWhich, bool bInParents=true) const
 
SfxItemState GetItemState (sal_uInt16 nWhich, bool bSrchInParent=true, const SfxPoolItem **ppItem=nullptr) const
 
SfxItemState GetBackgroundState (std::shared_ptr< SvxBrushItem > &rItem) const
 
virtual bool SetFormatAttr (const SfxPoolItem &rAttr)
 
virtual bool SetFormatAttr (const SfxItemSet &rSet)
 
virtual bool ResetFormatAttr (sal_uInt16 nWhich1, sal_uInt16 nWhich2=0)
 
virtual sal_uInt16 ResetAllFormatAttr ()
 Takes all hints from Delta-Array,. More...
 
SwFormatDerivedFrom () const
 
bool IsDefault () const
 
const OUString & GetName () const
 
bool HasName (const OUString &rName) const
 
const SwAttrSetGetAttrSet () const
 For querying the attribute array. More...
 
const SwDocGetDoc () const
 The document is set in SwAttrPool now, therefore you always can access it. More...
 
SwDocGetDoc ()
 
const IDocumentSettingAccessgetIDocumentSettingAccess () const
 Provides access to the document settings interface. More...
 
const IDocumentDrawModelAccessgetIDocumentDrawModelAccess () const
 Provides access to the document draw model interface. More...
 
IDocumentDrawModelAccessgetIDocumentDrawModelAccess ()
 
const IDocumentLayoutAccessgetIDocumentLayoutAccess () const
 Provides access to the document layout interface. More...
 
IDocumentLayoutAccessgetIDocumentLayoutAccess ()
 
IDocumentTimerAccessgetIDocumentTimerAccess ()
 Provides access to the document idle timer interface. More...
 
IDocumentFieldsAccessgetIDocumentFieldsAccess ()
 Provides access to the document idle timer interface. More...
 
IDocumentChartDataProviderAccessgetIDocumentChartDataProviderAccess ()
 Gives access to the chart data-provider. More...
 
sal_uInt16 GetPoolFormatId () const
 Get and set Pool style IDs. More...
 
void SetPoolFormatId (sal_uInt16 nId)
 
sal_uInt16 GetPoolHelpId () const
 Get and set Help-IDs for document templates. More...
 
void SetPoolHelpId (sal_uInt16 nId)
 
sal_uInt8 GetPoolHlpFileId () const
 
void SetPoolHlpFileId (sal_uInt8 nId)
 
void GetPresentation (SfxItemPresentation ePres, MapUnit eCoreMetric, MapUnit ePresMetric, OUString &rText) const
 Get attribute-description. Returns passed string. More...
 
bool IsAuto () const
 Query / set AutoFormat-flag. More...
 
void SetAuto (bool bNew)
 
bool IsHidden () const
 
void SetHidden (bool bValue)
 
void GetGrabBagItem (css::uno::Any &rVal) const
 
void SetGrabBagItem (const css::uno::Any &rVal)
 
bool IsAutoUpdateFormat () const
 Query / set bAutoUpdateFormat-flag. More...
 
void SetAutoUpdateFormat (bool bNew=true)
 
bool IsFormatInDTOR () const
 
const SvxUnderlineItemGetUnderline (bool=true) const
 GetMethods: Bool indicates whether to search only in Set (FALSE) or also in Parents. More...
 
const SvxFontHeightItemGetSize (bool=true) const
 
const SvxFontItemGetFont (bool=true) const
 
const SvxColorItemGetColor (bool=true) const
 
const SvxFontItemGetCJKFont (bool=true) const
 
const SvxFontItemGetCTLFont (bool=true) const
 
const SwFormatFillOrderGetFillOrder (bool=true) const
 Frame-attributes - implemented in frmatr.hxx. More...
 
const SwFormatFrameSizeGetFrameSize (bool=true) const
 
const SwFormatHeaderGetHeader (bool=true) const
 
const SwFormatFooterGetFooter (bool=true) const
 
const SwFormatSurroundGetSurround (bool=true) const
 
const SwFormatHoriOrientGetHoriOrient (bool=true) const
 
const SwFormatAnchorGetAnchor (bool=true) const
 
const SwFormatColGetCol (bool=true) const
 
const SvxPaperBinItemGetPaperBin (bool=true) const
 
const SvxLRSpaceItemGetLRSpace (bool=true) const
 
const SvxULSpaceItemGetULSpace (bool=true) const
 
const SwFormatContentGetContent (bool=true) const
 
const SvxPrintItemGetPrint (bool=true) const
 
const SvxOpaqueItemGetOpaque (bool=true) const
 
const SvxProtectItemGetProtect (bool=true) const
 
const SwFormatVertOrientGetVertOrient (bool=true) const
 
const SvxBoxItemGetBox (bool=true) const
 
const SvxFormatKeepItemGetKeep (bool=true) const
 
std::shared_ptr< SvxBrushItemmakeBackgroundBrushItem (bool=true) const
 
const SvxShadowItemGetShadow (bool=true) const
 
const SwFormatPageDescGetPageDesc (bool=true) const
 
const SvxFormatBreakItemGetBreak (bool=true) const
 
const SvxMacroItemGetMacro (bool=true) const
 
const SwFormatURLGetURL (bool=true) const
 
const SwFormatEditInReadonlyGetEditInReadonly (bool=true) const
 
const SwFormatLayoutSplitGetLayoutSplit (bool=true) const
 
const SwFormatRowSplitGetRowSplit (bool=true) const
 
const SwFormatChainGetChain (bool=true) const
 
const SwFormatFootnoteAtTextEndGetFootnoteAtTextEnd (bool=true) const
 
const SwFormatEndAtTextEndGetEndAtTextEnd (bool=true) const
 
const SwFormatNoBalancedColumnsGetBalancedColumns (bool=true) const
 
const SvxFrameDirectionItemGetFrameDir (bool=true) const
 
const SwTextGridItemGetTextGrid (bool=true) const
 
const SwHeaderAndFooterEatSpacingItemGetHeaderAndFooterEatSpacing (bool=true) const
 
const SwFormatFollowTextFlowGetFollowTextFlow (bool=true) const
 
const SwFormatWrapInfluenceOnObjPosGetWrapInfluenceOnObjPos (bool=true) const
 
const SdrTextVertAdjustItemGetTextVertAdjust (bool=true) const
 
const SvxLineSpacingItemGetLineSpacing (bool=true) const
 Paragraph-attributes - implemented in paratr.hxx. More...
 
const SwNumRuleItemGetNumRule (bool=true) const
 
const SvxTabStopItemGetTabStops (bool=true) const
 
const SwFormatDropGetDrop (bool=true) const
 
const SwTableBoxNumFormatGetTableBoxNumFormat (bool=true) const
 TableBox attributes - implemented in cellatr.hxx. More...
 
const SwTableBoxFormulaGetTableBoxFormula (bool=true) const
 
const SwTableBoxValueGetTableBoxValue (bool=true) const
 
- Public Member Functions inherited from sw::BroadcastingModify
virtual void CallSwClientNotify (const SfxHint &rHint) const override
 
- Public Member Functions inherited from SwModify
 SwModify ()
 
 SwModify (SwModify *pToRegisterIn)
 
void NotifyClients (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
 
void ModifyBroadcast (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
 
virtual ~SwModify () override
 
void Add (SwClient *pDepend)
 
SwClientRemove (SwClient *pDepend)
 
bool HasWriterListeners () const
 
void LockModify ()
 
void UnlockModify ()
 
void SetInCache (bool bNew)
 
void SetInSwFntCache (bool bNew)
 
void SetInDocDTOR ()
 
bool IsModifyLocked () const
 
bool IsInCache () const
 
bool IsInSwFntCache () const
 
void CheckCaching (const sal_uInt16 nWhich)
 
bool HasOnlyOneListener ()
 
- Public Member Functions inherited from SwClient
 SwClient ()
 
 SwClient (SwClient &&) noexcept
 
virtual ~SwClient () override
 
virtual void SwClientNotify (const SwModify &, const SfxHint &rHint) override
 
std::unique_ptr< sw::ModifyChangedHintCheckRegistration (const SfxPoolItem *pOldValue)
 
virtual void ModifyNotification (const SfxPoolItem *pOldValue, const SfxPoolItem *pNewValue)
 
void SwClientNotifyCall (const SwModify &rModify, const SfxHint &rHint)
 
const SwModifyGetRegisteredIn () const
 
SwModifyGetRegisteredIn ()
 
void EndListeningAll ()
 
void StartListeningToSameModifyAs (const SwClient &)
 
- Public Member Functions inherited from sw::WriterListener
bool IsLast () const
 
- Public Member Functions inherited from sw::BroadcasterMixin
 BroadcasterMixin ()=default
 
 BroadcasterMixin (BroadcasterMixin const &)=default
 
BroadcasterMixinoperator= (const BroadcasterMixin &)
 
SvtBroadcasterGetNotifier ()
 

Private Member Functions

 SwFlyFrameFormat (const SwFlyFrameFormat &rCpy)=delete
 
SwFlyFrameFormatoperator= (const SwFlyFrameFormat &rCpy)=delete
 
 SwFlyFrameFormat (SwAttrPool &rPool, const OUString &rFormatNm, SwFrameFormat *pDrvdFrame)
 

Private Attributes

OUString msTitle
 
OUString msDesc
 
Point m_aLastFlyFramePrtRectPos
 Both not existent. More...
 
std::unique_ptr< SwFlyDrawContactm_pContact
 

Friends

class SwDoc
 

Additional Inherited Members

- Public Types inherited from SwFrameFormat
enum  tLayoutDir {
  HORI_L2R,
  HORI_R2L,
  VERT_R2L
}
 
- Protected Member Functions inherited from SwFrameFormat
 SwFrameFormat (SwAttrPool &rPool, const sal_Char *pFormatNm, SwFrameFormat *pDrvdFrame, sal_uInt16 nFormatWhich=RES_FRMFMT, const sal_uInt16 *pWhichRange=nullptr)
 
 SwFrameFormat (SwAttrPool &rPool, const OUString &rFormatNm, SwFrameFormat *pDrvdFrame, sal_uInt16 nFormatWhich=RES_FRMFMT, const sal_uInt16 *pWhichRange=nullptr)
 
virtual void Modify (const SfxPoolItem *pOld, const SfxPoolItem *pNewValue) override
 
SwFrameFormatGetOtherTextBoxFormat () const
 
void SetOtherTextBoxFormat (SwFrameFormat *pFormat)
 
- Protected Member Functions inherited from SwFormat
 SwFormat (SwAttrPool &rPool, const sal_Char *pFormatNm, const sal_uInt16 *pWhichRanges, SwFormat *pDrvdFrame, sal_uInt16 nFormatWhich)
 
 SwFormat (SwAttrPool &rPool, const OUString &rFormatNm, const sal_uInt16 *pWhichRanges, SwFormat *pDrvdFrame, sal_uInt16 nFormatWhich)
 
 SwFormat (const SwFormat &rFormat)
 
- Protected Member Functions inherited from SwClient
 SwClient (SwModify *pToRegisterIn)
 
SwModifyGetRegisteredInNonConst () const
 
- Protected Member Functions inherited from sw::WriterListener
 WriterListener ()
 
virtual ~WriterListener () COVERITY_NOEXCEPT_FALSE
 

Detailed Description

Definition at line 185 of file frmfmt.hxx.

Constructor & Destructor Documentation

SwFlyFrameFormat::SwFlyFrameFormat ( const SwFlyFrameFormat rCpy)
privatedelete
SwFlyFrameFormat::SwFlyFrameFormat ( SwAttrPool rPool,
const OUString &  rFormatNm,
SwFrameFormat pDrvdFrame 
)
private

Definition at line 2816 of file atrfrm.cxx.

SwFlyFrameFormat::~SwFlyFrameFormat ( )
overridevirtual

Member Function Documentation

SwAnchoredObject * SwFlyFrameFormat::GetAnchoredObj ( ) const

Definition at line 3045 of file atrfrm.cxx.

References GetFrame().

Referenced by SwInsertChart().

SwFlyFrame * SwFlyFrameFormat::GetFrame ( const Point pDocPos = nullptr) const
bool SwFlyFrameFormat::GetInfo ( SfxPoolItem rInfo) const
overridevirtual
const Point& SwFlyFrameFormat::GetLastFlyFramePrtRectPos ( ) const
inline

Definition at line 244 of file frmfmt.hxx.

Referenced by SwFEShell::AlignFormulaToBaseline(), and SwWrtShell::CalcAndSetScale().

OUString SwFlyFrameFormat::GetObjDescription ( ) const
OUString SwFlyFrameFormat::GetObjTitle ( ) const
SwFlyDrawContact * SwFlyFrameFormat::GetOrCreateContact ( )
bool SwFlyFrameFormat::IsBackgroundBrushInherited ( ) const

SwFlyFrameFormat::IsBackgroundBrushInherited.

SwFlyFrameFormat::IsBackgroundBrushInherited - for #103898#.

Method to determine, if the brush for drawing the background is "inherited" from its parent/grandparent. This is the case, if no background graphic is set and the background color is "no fill"/"auto fill"

Returns
true, if background brush is "inherited" from parent/grandparent

OD 08.10.2002 - method to determine, if the brush for drawing the background is "inherited" from its parent/grandparent. This is the case, if no background graphic is set and the background color is "no fill"/"auto fill" NOTE: condition is "copied" from method <SwFrame::GetBackgroundBrush(..).

Returns
true, if background brush is "inherited" from parent/grandparent

Definition at line 3203 of file atrfrm.cxx.

References COL_TRANSPARENT(), SwFrameFormat::getSdrAllFillAttributesHelper(), SwFormat::makeBackgroundBrushItem(), and SwFrameFormat::supportsFullDrawingLayerFillAttributeSet().

Referenced by lcl_SubtractFlys().

bool SwFlyFrameFormat::IsBackgroundTransparent ( ) const
overridevirtual

SwFlyFrameFormat::IsBackgroundTransparent.

SwFlyFrameFormat::IsBackgroundTransparent - for #99657#.

Override virtual method and its default implementation, because format of fly frame provides transparent backgrounds. Method determines, if background of fly frame is transparent.

Returns
true, if background color is transparent, but not "no fill" or a existing background graphic is transparent.

OD 22.08.2002 - overriding virtual method and its default implementation, because format of fly frame provides transparent backgrounds. Method determines, if background of fly frame is transparent.

Returns
true, if background color is transparent, but not "no fill" or the transparency of a existing background graphic is set.

Reimplemented from SwFormat.

Definition at line 3161 of file atrfrm.cxx.

References COL_TRANSPARENT(), GraphicObject::GetAttr(), SwFrameFormat::getSdrAllFillAttributesHelper(), GraphicAttr::GetTransparency(), SwFormat::makeBackgroundBrushItem(), and SwFrameFormat::supportsFullDrawingLayerFillAttributeSet().

Referenced by SwFlyFrame::IsBackgroundTransparent().

void SwFlyFrameFormat::MakeFrames ( )
overridevirtual
Graphic SwFlyFrameFormat::MakeGraphic ( ImageMap pMap = nullptr)
overridevirtual
SwFlyFrameFormat& SwFlyFrameFormat::operator= ( const SwFlyFrameFormat rCpy)
privatedelete
void SwFlyFrameFormat::SetLastFlyFramePrtRectPos ( const Point rPoint)
inline

Definition at line 245 of file frmfmt.hxx.

Referenced by SwFEShell::RequestObjectResize().

void SwFlyFrameFormat::SetObjDescription ( const OUString &  rDescription,
bool  bBroadcast = false 
)
void SwFlyFrameFormat::SetObjTitle ( const OUString &  rTitle,
bool  bBroadcast = false 
)

Friends And Related Function Documentation

friend class SwDoc
friend

Definition at line 187 of file frmfmt.hxx.

Member Data Documentation

Point SwFlyFrameFormat::m_aLastFlyFramePrtRectPos
private

Both not existent.

it stores the previous position of Prt rectangle from RequestObjectResize so it can be used to move frames of non-resizable objects to align them correctly when they get borders (this is done in SwWrtShell::CalcAndGetScale)

Definition at line 195 of file frmfmt.hxx.

std::unique_ptr<SwFlyDrawContact> SwFlyFrameFormat::m_pContact
private

Definition at line 196 of file frmfmt.hxx.

Referenced by GetOrCreateContact().

OUString SwFlyFrameFormat::msDesc
private

Definition at line 189 of file frmfmt.hxx.

Referenced by GetObjDescription(), and SetObjDescription().

OUString SwFlyFrameFormat::msTitle
private

Definition at line 188 of file frmfmt.hxx.

Referenced by GetObjTitle(), and SetObjTitle().


The documentation for this class was generated from the following files: