sw/inc/swatrset.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_SW_INC_SWATRSET_HXX
  20 #define INCLUDED_SW_INC_SWATRSET_HXX
  21
  22 #include <svl/itemset.hxx>
  23 #include <svl/itempool.hxx>
  24 #include "swdllapi.h"
  25 #include "calbck.hxx"
  26
  27 class SwDoc;
  28 class OutputDevice;
  29 class IDocumentSettingAccess;
  30 class SvxPostureItem;
  31 class SvxWeightItem;
  32 class SvxShadowedItem;
  33 class SvxAutoKernItem;
  34 class SvxWordLineModeItem;
  35 class SvxContourItem;
  36 class SvxKerningItem;
  37 class SvxUnderlineItem;
  38 class SvxOverlineItem;
  39 class SvxCrossedOutItem;
  40 class SvxFontHeightItem;
  41 class SvxFontItem;
  42 class SvxColorItem;
  43 class SvxLanguageItem;
  44 class SvxEscapementItem;
  45 class SvxCaseMapItem;
  46 class SvxNoHyphenItem;
  47 class SvxBlinkItem;
  48 class SvxEmphasisMarkItem;
  49 class SvxTwoLinesItem;
  50 class SvxCharScaleWidthItem;
  51 class SvxCharRotateItem;
  52 class SvxCharReliefItem;
  53 class SvxCharHiddenItem;
  54
  55 // Frame attributes
  56 class SwFormatFillOrder;
  57 class SwFormatFrameSize;
  58 class SvxPaperBinItem;
  59 class SvxLeftMarginItem;
  60 class SvxTextLeftMarginItem;
  61 class SvxFirstLineIndentItem;
  62 class SvxRightMarginItem;
  63 class SvxGutterLeftMarginItem;
  64 class SvxGutterRightMarginItem;
  65 class SvxLRSpaceItem;
  66 class SvxULSpaceItem;
  67 class SwFormatContent;
  68 class SwFormatHeader;
  69 class SwFormatFooter;
  70 class SvxPrintItem;
  71 class SvxOpaqueItem;
  72 class SvxProtectItem;
  73 class SwFormatSurround;
  74 class SwFormatVertOrient;
  75 class SwFormatHoriOrient;
  76 class SwFormatAnchor;
  77 class SvxBoxItem;
  78 class SvxBrushItem;
  79 class SvxShadowItem;
  80 class SwFormatPageDesc;
  81 class SvxFormatBreakItem;
  82 class SwFormatCol;
  83 class SvxMacroItem;
  84 class SvxFormatKeepItem;
  85 class SwFormatURL;
  86 class SwFormatLineNumber;
  87 class SwFormatEditInReadonly;
  88 class SwFormatLayoutSplit;
  89 class SwFormatRowSplit;
  90 class SwFormatFlySplit;
  91 class SwFormatWrapTextAtFlyStart;
  92 class SwFormatChain;
  93 class SwFormatFootnoteAtTextEnd;
  94 class SwFormatEndAtTextEnd;
  95 class SwFormatNoBalancedColumns;
  96 class SvxFrameDirectionItem;
  97 class SwHeaderAndFooterEatSpacingItem;
  98 class SwFormatFollowTextFlow;
  99 class SwFormatWrapInfluenceOnObjPos;
 100 class SdrTextVertAdjustItem;
 101
 102 // Graphic attributes
 103 class SwMirrorGrf;
 104 class SwCropGrf;
 105 class SwRotationGrf;
 106 class SwLuminanceGrf;
 107 class SwContrastGrf;
 108 class SwChannelRGrf;
 109 class SwChannelGGrf;
 110 class SwChannelBGrf;
 111 class SwGammaGrf;
 112 class SwInvertGrf;
 113 class SwTransparencyGrf;
 114 class SwDrawModeGrf;
 115
 116 // Paragraph attributes
 117 class SvxLineSpacingItem;
 118 class SvxAdjustItem;
 119 class SvxFormatSplitItem;
 120 class SwRegisterItem;
 121 class SwNumRuleItem;
 122 class SvxWidowsItem;
 123 class SvxOrphansItem;
 124 class SvxTabStopItem;
 125 class SvxHyphenZoneItem;
 126 class SwFormatDrop;
 127 class SvxScriptSpaceItem;
 128 class SvxHangingPunctuationItem;
 129 class SvxForbiddenRuleItem;
 130 class SvxParaVertAlignItem;
 131 class SvxParaGridItem;
 132 class SwParaConnectBorderItem;
 133
 134 // TableBox attributes
 135 class SwTableBoxNumFormat;
 136 class SwTableBoxFormula;
 137 class SwTableBoxValue;
 138
 139 namespace vcl {
 140     typedef OutputDevice RenderContext;
 141 };
 142
 143 class SAL_DLLPUBLIC_RTTI SwAttrPool final : public SfxItemPool
 144 {
 145 private:
 146     friend void InitCore();            // For creating/deleting of version maps.
 147     friend void FinitCore();
 148
 149     SwDoc* m_pDoc;
 150
 151 public:
 152     SwAttrPool( SwDoc* pDoc );
 153 private:
 154     virtual ~SwAttrPool() override;
 155 public:
 156
 157           SwDoc* GetDoc()           { return m_pDoc; }
 158     const SwDoc* GetDoc() const     { return m_pDoc; }
 159
 160 };
 161
 162 class SW_DLLPUBLIC SwAttrSet final : public SfxItemSet
 163 {
 164     // Pointer for Modify-System
 165     SwAttrSet *m_pOldSet;
 166     SwAttrSet *m_pNewSet;
 167
 168     // processor for change callback
 169     virtual void Changed(const SfxPoolItem* pOld, const SfxPoolItem* pNew) const override;
 170
 171 public:
 172     SwAttrSet( SwAttrPool&, sal_uInt16 nWhich1, sal_uInt16 nWhich2 );
 173     SwAttrSet( SwAttrPool&, const WhichRangesContainer& nWhichPairTable );
 174     SwAttrSet( const SwAttrSet& );
 175
 176     virtual std::unique_ptr<SfxItemSet> Clone(bool bItems = true, SfxItemPool *pToPool = nullptr) const override;
 177     SwAttrSet CloneAsValue(bool bItems = true) const;
 178
 179     bool Put_BC( const SfxPoolItem& rAttr, SwAttrSet* pOld, SwAttrSet* pNew );
 180     bool Put_BC( const SfxItemSet& rSet, SwAttrSet* pOld, SwAttrSet* pNew );
 181
 182     // Delete an item or a range.
 183     sal_uInt16 ClearItem_BC( sal_uInt16 nWhich, SwAttrSet* pOld, SwAttrSet* pNew );
 184     sal_uInt16 ClearItem_BC( sal_uInt16 nWhich1, sal_uInt16 nWhich2,
 185                         SwAttrSet* pOld = nullptr, SwAttrSet* pNew = nullptr );
 186
 187     int Intersect_BC( const SfxItemSet& rSet, SwAttrSet* pOld, SwAttrSet* pNew );
 188
 189     void GetPresentation( SfxItemPresentation ePres,
 190         MapUnit eCoreMetric, MapUnit ePresMetric, OUString &rText ) const;
 191
 192     SwAttrPool* GetPool() const { return static_cast<SwAttrPool*>(SfxItemSet::GetPool()); }
 193
 194     // Copy attributes, if necessary across documents.
 195     void CopyToModify( sw::BroadcastingModify& rMod ) const;
 196
 197     // Special treatment for some attributes.
 198     // Set Modify-pointer (the old pDefinedIn) at the following attributes:
 199     //  - SwFormatDropCaps
 200     //  - SwFormatPageDesc
 201     // (Is called at insert in formats/nodes.)
 202     // Second version is for the SwAttrSet handles of SwContentNode.
 203     bool SetModifyAtAttr( const sw::BroadcastingModify* pModify );
 204
 205     // Document is set at SwAttrPool. Therefore it is always accessible.
 206     const SwDoc *GetDoc() const { return GetPool()->GetDoc(); }
 207           SwDoc *GetDoc()       { return GetPool()->GetDoc(); }
 208
 209     // Get methods: bool indicates whether to search only in Set (when false)
 210     // or also in parents. If nothing is found then default attribute is returned.
 211     // Character attributes. Implementation in charatr.hxx.
 212     inline const SvxPostureItem           &GetPosture( bool = true ) const;
 213     inline const SvxWeightItem          &GetWeight( bool = true ) const;
 214     inline const SvxShadowedItem        &GetShadowed( bool = true ) const;
 215     inline const SvxAutoKernItem        &GetAutoKern( bool = true ) const;
 216     inline const SvxWordLineModeItem    &GetWordLineMode( bool = true ) const;
 217     inline const SvxContourItem         &GetContour( bool = true ) const;
 218     inline const SvxKerningItem         &GetKerning( bool = true ) const;
 219     inline const SvxUnderlineItem       &GetUnderline( bool = true ) const;
 220     inline const SvxOverlineItem        &GetOverline( bool = true ) const;
 221     inline const SvxCrossedOutItem      &GetCrossedOut( bool = true ) const;
 222     inline const SvxFontHeightItem        &GetSize( bool = true ) const;
 223     inline const SvxFontItem            &GetFont( bool = true ) const;
 224     inline const SvxColorItem           &GetColor( bool = true ) const;
 225     inline const SvxLanguageItem        &GetLanguage( bool = true ) const;
 226     inline const SvxEscapementItem      &GetEscapement( bool = true ) const;
 227     inline const SvxCaseMapItem         &GetCaseMap( bool = true ) const;
 228     inline const SvxNoHyphenItem      &GetNoHyphenHere( bool = true ) const;
 229     inline const SvxFontItem          &GetCJKFont( bool = true ) const;
 230     inline const SvxFontHeightItem    &GetCJKSize( bool = true ) const;
 231     inline const SvxLanguageItem      &GetCJKLanguage( bool = true ) const;
 232     inline const SvxPostureItem       &GetCJKPosture( bool = true ) const;
 233     inline const SvxWeightItem        &GetCJKWeight( bool = true ) const;
 234     inline const SvxFontItem          &GetCTLFont( bool = true ) const;
 235     inline const SvxFontHeightItem    &GetCTLSize( bool = true ) const;
 236     inline const SvxLanguageItem      &GetCTLLanguage( bool = true ) const;
 237     inline const SvxPostureItem       &GetCTLPosture( bool = true ) const;
 238     inline const SvxWeightItem        &GetCTLWeight( bool = true ) const;
 239     inline const SvxEmphasisMarkItem  &GetEmphasisMark( bool = true ) const;
 240     inline const SvxTwoLinesItem      &Get2Lines( bool = true ) const;
 241     inline const SvxCharScaleWidthItem    &GetCharScaleW( bool = true ) const;
 242     inline const SvxCharRotateItem        &GetCharRotate( bool = true ) const;
 243     inline const SvxCharReliefItem        &GetCharRelief( bool = true ) const;
 244     inline const SvxCharHiddenItem      &GetCharHidden( bool = true ) const;
 245
 246     // Frame attributes. Implementation in frmatr.hxx.
 247     inline const SwFormatFillOrder       &GetFillOrder( bool = true ) const;
 248     inline const SwFormatFrameSize             &GetFrameSize( bool = true ) const;
 249     inline const SvxPaperBinItem      &GetPaperBin( bool = true ) const;
 250     inline const SvxLeftMarginItem &    GetLeftMargin(bool = true) const;
 251     inline const SvxTextLeftMarginItem &GetTextLeftMargin(bool = true) const;
 252     inline const SvxFirstLineIndentItem &GetFirstLineIndent(bool = true) const;
 253     inline const SvxRightMarginItem &   GetRightMargin(bool = true) const;
 254     inline const SvxGutterLeftMarginItem &GetGutterLeftMargin(bool = true) const;
 255     inline const SvxGutterRightMarginItem &GetGutterRightMargin(bool = true) const;
 256     inline const SvxLRSpaceItem           &GetLRSpace( bool = true ) const;
 257     inline const SvxULSpaceItem           &GetULSpace( bool = true ) const;
 258     inline const SwFormatContent           &GetContent( bool = true ) const;
 259     inline const SwFormatHeader          &GetHeader( bool = true ) const;
 260     inline const SwFormatFooter          &GetFooter( bool = true ) const;
 261     inline const SvxPrintItem             &GetPrint( bool = true ) const;
 262     inline const SvxOpaqueItem            &GetOpaque( bool = true ) const;
 263     inline const SvxProtectItem           &GetProtect( bool = true ) const;
 264     inline const SwFormatSurround            &GetSurround( bool = true ) const;
 265     inline const SwFormatVertOrient      &GetVertOrient( bool = true ) const;
 266     inline const SwFormatHoriOrient      &GetHoriOrient( bool = true ) const;
 267     inline const SwFormatAnchor          &GetAnchor( bool = true ) const;
 268     inline const SvxBoxItem               &GetBox( bool = true ) const;
 269     inline const SvxFormatKeepItem         &GetKeep( bool = true ) const;
 270     inline const SvxBrushItem           &GetBackground( bool = true ) const;
 271     inline const SvxShadowItem            &GetShadow( bool = true ) const;
 272     inline const SwFormatPageDesc            &GetPageDesc( bool = true ) const;
 273     inline const SvxFormatBreakItem      &GetBreak( bool = true ) const;
 274     inline const SwFormatCol                 &GetCol( bool = true ) const;
 275     inline const SvxMacroItem             &GetMacro( bool = true ) const;
 276     inline const SwFormatURL             &GetURL( bool = true ) const;
 277     inline const SwFormatEditInReadonly  &GetEditInReadonly( bool = true ) const;
 278     inline const SwFormatLayoutSplit     &GetLayoutSplit( bool = true ) const;
 279     inline const SwFormatRowSplit          &GetRowSplit( bool = true ) const;
 280     inline const SwFormatFlySplit          &GetFlySplit( bool = true ) const;
 281     inline const SwFormatWrapTextAtFlyStart &GetWrapTextAtFlyStart( bool = true ) const;
 282     inline const SwFormatChain             &GetChain( bool = true ) const;
 283     inline const SwFormatLineNumber      &GetLineNumber( bool = true ) const;
 284     inline const SwFormatFootnoteAtTextEnd     &GetFootnoteAtTextEnd( bool = true ) const;
 285     inline const SwFormatEndAtTextEnd     &GetEndAtTextEnd( bool = true ) const;
 286     inline const SwFormatNoBalancedColumns &GetBalancedColumns( bool = true ) const;
 287     inline const SvxFrameDirectionItem    &GetFrameDir( bool = true ) const;
 288     inline const SwHeaderAndFooterEatSpacingItem &GetHeaderAndFooterEatSpacing( bool = true ) const;
 289     inline const SwFormatFollowTextFlow    &GetFollowTextFlow(bool = true) const;
 290     inline const SwFormatWrapInfluenceOnObjPos& GetWrapInfluenceOnObjPos(bool = true) const;
 291     inline const SdrTextVertAdjustItem& GetTextVertAdjust(bool = true) const;
 292
 293     // Graphic attributes   - implementation in grfatr.hxx
 294     inline const SwMirrorGrf            &GetMirrorGrf( bool = true ) const;
 295     inline const SwCropGrf            &GetCropGrf( bool = true ) const;
 296     inline const SwRotationGrf            &GetRotationGrf(bool = true ) const;
 297     inline const SwLuminanceGrf       &GetLuminanceGrf(bool = true ) const;
 298     inline const SwContrastGrf            &GetContrastGrf(bool = true ) const;
 299     inline const SwChannelRGrf            &GetChannelRGrf(bool = true ) const;
 300     inline const SwChannelGGrf            &GetChannelGGrf(bool = true ) const;
 301     inline const SwChannelBGrf            &GetChannelBGrf(bool = true ) const;
 302     inline const SwGammaGrf           &GetGammaGrf(bool = true ) const;
 303     inline const SwInvertGrf          &GetInvertGrf(bool = true ) const;
 304     inline const SwTransparencyGrf        &GetTransparencyGrf(bool = true ) const;
 305     inline const SwDrawModeGrf            &GetDrawModeGrf(bool = true ) const;
 306
 307     // Paragraph attributes - implementation in paratr.hxx
 308     inline const SvxLineSpacingItem       &GetLineSpacing( bool = true ) const;
 309     inline const SvxAdjustItem            &GetAdjust( bool = true ) const;
 310     inline const SvxFormatSplitItem      &GetSplit( bool = true ) const;
 311     inline const SwRegisterItem           &GetRegister( bool = true ) const;
 312     inline const SwNumRuleItem            &GetNumRule( bool = true ) const;
 313     inline const SvxWidowsItem            &GetWidows( bool = true ) const;
 314     inline const SvxOrphansItem           &GetOrphans( bool = true ) const;
 315     inline const SvxTabStopItem           &GetTabStops( bool = true ) const;
 316     inline const SvxHyphenZoneItem        &GetHyphenZone( bool = true ) const;
 317     inline const SwFormatDrop                &GetDrop( bool = true ) const;
 318     inline const SvxScriptSpaceItem       &GetScriptSpace(bool = true) const;
 319     inline const SvxHangingPunctuationItem &GetHangingPunctuation(bool = true) const;
 320     inline const SvxForbiddenRuleItem     &GetForbiddenRule(bool = true) const;
 321     inline const SvxParaVertAlignItem &GetParaVertAlign(bool = true) const;
 322     inline const SvxParaGridItem        &GetParaGrid(bool = true) const;
 323     inline const SwParaConnectBorderItem &GetParaConnectBorder(bool = true ) const;
 324
 325     // Tablebox attributes  - implementation in cellatr.hxx
 326     inline  const SwTableBoxNumFormat       &GetTableBoxNumFormat( bool = true ) const;
 327     inline  const SwTableBoxFormula     &GetTableBoxFormula( bool = true ) const;
 328     inline  const SwTableBoxValue           &GetTableBoxValue( bool = true ) const;
 329 };
 330
 331 //Helper for filters to find true lineheight of a font
 332 SW_DLLPUBLIC tools::Long AttrSetToLineHeight( const IDocumentSettingAccess& rIDocumentSettingAccess,
 333                           const SwAttrSet &rSet,
 334                           const vcl::RenderContext &rOut, sal_Int16 nScript);
 335 #endif
 336
 337 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */