sc/inc/attrib.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
  20 #ifndef INCLUDED_SC_INC_ATTRIB_HXX
  21 #define INCLUDED_SC_INC_ATTRIB_HXX
  22
  23 #include <memory>
  24 #include <svl/poolitem.hxx>
  25 #include <svl/intitem.hxx>
  26 #include <svl/eitem.hxx>
  27 #include <o3tl/typed_flags_set.hxx>
  28 #include "scdllapi.h"
  29 #include "global.hxx"
  30
  31 // flags for cells hidden by merge
  32 // and control for auto filter
  33 enum class ScMF {
  34     NONE           = 0x0000,
  35     Hor            = 0x0001,
  36     Ver            = 0x0002,
  37     Auto           = 0x0004,  /// autofilter arrow
  38     Button         = 0x0008,  /// field button for datapilot
  39     Scenario       = 0x0010,
  40     ButtonPopup    = 0x0020,  /// dp button with popup arrow
  41     HiddenMember   = 0x0040,  /// dp field button with presence of hidden member
  42     DpTable        = 0x0080,  /// dp table output
  43     All            = 0x00FF
  44 };
  45 namespace o3tl {
  46     template<> struct typed_flags<ScMF> : is_typed_flags<ScMF, 0xff> {};
  47 }
  48
  49 class EditTextObject;
  50 namespace editeng { class SvxBorderLine; }
  51
  52 bool SC_DLLPUBLIC ScHasPriority( const ::editeng::SvxBorderLine* pThis, const ::editeng::SvxBorderLine* pOther );
  53
  54 class SC_DLLPUBLIC ScMergeAttr: public SfxPoolItem
  55 {
  56     SCCOL       nColMerge;
  57     SCROW       nRowMerge;
  58 public:
  59                 ScMergeAttr();
  60                 ScMergeAttr( SCCOL nCol, SCROW nRow );
  61                 ScMergeAttr( const ScMergeAttr& );
  62                 virtual ~ScMergeAttr() override;
  63
  64     virtual bool            operator==( const SfxPoolItem& ) const override;
  65     virtual SfxPoolItem*    Clone( SfxItemPool *pPool = nullptr ) const override;
  66
  67             SCCOL          GetColMerge() const {return nColMerge; }
  68             SCROW          GetRowMerge() const {return nRowMerge; }
  69
  70             bool            IsMerged() const { return nColMerge>1 || nRowMerge>1; }
  71
  72     ScMergeAttr& operator=(const ScMergeAttr& rMerge)
  73             {
  74                 nColMerge = rMerge.nColMerge;
  75                 nRowMerge = rMerge.nRowMerge;
  76                 return *this;
  77             }
  78
  79     virtual void dumpAsXml(struct _xmlTextWriter* pWriter) const override;
  80 };
  81
  82 class SC_DLLPUBLIC ScMergeFlagAttr: public SfxInt16Item
  83 {
  84 public:
  85             ScMergeFlagAttr();
  86             ScMergeFlagAttr(ScMF nFlags);
  87             virtual ~ScMergeFlagAttr() override;
  88
  89     SfxPoolItem * Clone(SfxItemPool * pPool = nullptr) const override;
  90
  91     ScMF    GetValue() const { return static_cast<ScMF>(SfxInt16Item::GetValue()); }
  92
  93     bool    IsHorOverlapped() const     { return bool( GetValue() & ScMF::Hor );  }
  94     bool    IsVerOverlapped() const     { return bool( GetValue() & ScMF::Ver );  }
  95     bool    IsOverlapped() const        { return bool( GetValue() & ( ScMF::Hor | ScMF::Ver ) ); }
  96
  97     bool    HasAutoFilter() const       { return bool( GetValue() & ScMF::Auto ); }
  98
  99     bool    IsScenario() const          { return bool( GetValue() & ScMF::Scenario ); }
 100
 101     bool    HasPivotButton() const;
 102     bool    HasPivotPopupButton() const;
 103
 104     virtual void dumpAsXml(struct _xmlTextWriter* pWriter) const override;
 105 };
 106
 107 class SC_DLLPUBLIC ScProtectionAttr: public SfxPoolItem
 108 {
 109     bool        bProtection;    ///< protect cell
 110     bool        bHideFormula;   ///< hide formula
 111     bool        bHideCell;      ///< hide cell
 112     bool        bHidePrint;     ///< don't print cell
 113 public:
 114                             static SfxPoolItem* CreateDefault();
 115                             ScProtectionAttr();
 116                             ScProtectionAttr(   bool bProtect,
 117                                                 bool bHFormula = false,
 118                                                 bool bHCell = false,
 119                                                 bool bHPrint = false);
 120                             ScProtectionAttr( const ScProtectionAttr& );
 121                             virtual ~ScProtectionAttr() override;
 122
 123     OUString     GetValueText() const;
 124     virtual bool GetPresentation(
 125                                     SfxItemPresentation ePres,
 126                                     MapUnit eCoreMetric,
 127                                     MapUnit ePresMetric,
 128                                     OUString& rText,
 129                                     const IntlWrapper& rIntl ) const override;
 130
 131     virtual bool            operator==( const SfxPoolItem& ) const override;
 132     virtual SfxPoolItem*    Clone( SfxItemPool *pPool = nullptr ) const override;
 133
 134     virtual bool            QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
 135     virtual bool            PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
 136
 137             bool            GetProtection() const { return bProtection; }
 138             void            SetProtection( bool bProtect);
 139             bool            GetHideFormula() const { return bHideFormula; }
 140             void            SetHideFormula( bool bHFormula);
 141             bool            GetHideCell() const { return bHideCell; }
 142             void            SetHideCell( bool bHCell);
 143             bool            GetHidePrint() const { return bHidePrint; }
 144             void            SetHidePrint( bool bHPrint);
 145     ScProtectionAttr& operator=(const ScProtectionAttr& rProtection)
 146             {
 147                 bProtection = rProtection.bProtection;
 148                 bHideFormula = rProtection.bHideFormula;
 149                 bHideCell = rProtection.bHideCell;
 150                 bHidePrint = rProtection.bHidePrint;
 151                 return *this;
 152             }
 153 };
 154
 155 // page format item: contents of header and footer
 156
 157 #define SC_HF_LEFTAREA   1
 158 #define SC_HF_CENTERAREA 2
 159 #define SC_HF_RIGHTAREA  3
 160
 161 class SC_DLLPUBLIC ScPageHFItem : public SfxPoolItem
 162 {
 163     std::unique_ptr<EditTextObject> pLeftArea;
 164     std::unique_ptr<EditTextObject> pCenterArea;
 165     std::unique_ptr<EditTextObject> pRightArea;
 166
 167 public:
 168                 ScPageHFItem( sal_uInt16 nWhich );
 169                 ScPageHFItem( const ScPageHFItem& rItem );
 170                 virtual ~ScPageHFItem() override;
 171
 172     virtual bool            operator==( const SfxPoolItem& ) const override;
 173     virtual SfxPoolItem*    Clone( SfxItemPool *pPool = nullptr ) const override;
 174
 175     virtual bool            QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
 176     virtual bool            PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
 177
 178     const EditTextObject* GetLeftArea() const       { return pLeftArea.get(); }
 179     const EditTextObject* GetCenterArea() const     { return pCenterArea.get(); }
 180     const EditTextObject* GetRightArea() const      { return pRightArea.get(); }
 181
 182     void SetLeftArea( const EditTextObject& rNew );
 183     void SetCenterArea( const EditTextObject& rNew );
 184     void SetRightArea( const EditTextObject& rNew );
 185 };
 186
 187 // page format item: contents of header and footer
 188
 189 class SC_DLLPUBLIC ScViewObjectModeItem: public SfxEnumItem<ScVObjMode>
 190 {
 191 public:
 192                 ScViewObjectModeItem( sal_uInt16 nWhich );
 193                 ScViewObjectModeItem( sal_uInt16 nWhich, ScVObjMode eMode );
 194                 virtual ~ScViewObjectModeItem() override;
 195
 196     virtual sal_uInt16          GetValueCount() const override;
 197     virtual SfxPoolItem*        Clone( SfxItemPool *pPool = nullptr ) const override;
 198     virtual sal_uInt16          GetVersion( sal_uInt16 nFileVersion ) const override;
 199     virtual bool GetPresentation( SfxItemPresentation ePres,
 200                                   MapUnit eCoreMetric,
 201                                   MapUnit ePresMetric,
 202                                   OUString& rText,
 203                                   const IntlWrapper& rIntl ) const override;
 204 };
 205
 206 class ScDoubleItem : public SfxPoolItem
 207 {
 208 public:
 209                 static SfxPoolItem* CreateDefault();
 210                 ScDoubleItem( sal_uInt16 nWhich, double nVal );
 211                 ScDoubleItem( const ScDoubleItem& rItem );
 212                 virtual ~ScDoubleItem() override;
 213
 214     virtual bool            operator==( const SfxPoolItem& ) const override;
 215     virtual SfxPoolItem*    Clone( SfxItemPool *pPool = nullptr ) const override;
 216
 217 private:
 218     double  nValue;
 219 };
 220
 221 /** Member ID for "page scale to width" value in QueryValue() and PutValue(). */
 222 const sal_uInt8 SC_MID_PAGE_SCALETO_WIDTH    = 1;
 223 /** Member ID for "page scale to height" value in QueryValue() and PutValue(). */
 224 const sal_uInt8 SC_MID_PAGE_SCALETO_HEIGHT   = 2;
 225
 226 /** Contains the "scale to width/height" attribute in page styles. */
 227 class SC_DLLPUBLIC ScPageScaleToItem : public SfxPoolItem
 228 {
 229 public:
 230     /** Default c'tor sets the width and height to 0. */
 231     explicit                    ScPageScaleToItem();
 232     explicit                    ScPageScaleToItem( sal_uInt16 nWidth, sal_uInt16 nHeight );
 233
 234     virtual                     ~ScPageScaleToItem() override;
 235
 236     virtual ScPageScaleToItem*  Clone( SfxItemPool* = nullptr ) const override;
 237
 238     virtual bool                operator==( const SfxPoolItem& rCmp ) const override;
 239
 240     sal_uInt16           GetWidth() const { return mnWidth; }
 241     sal_uInt16           GetHeight() const { return mnHeight; }
 242     bool                 IsValid() const { return mnWidth || mnHeight; }
 243
 244     void                 SetWidth( sal_uInt16 nWidth ) { mnWidth = nWidth; }
 245     void                 SetHeight( sal_uInt16 nHeight ) { mnHeight = nHeight; }
 246     void                 Set( sal_uInt16 nWidth, sal_uInt16 nHeight )
 247                                     { mnWidth = nWidth; mnHeight = nHeight; }
 248
 249     virtual bool GetPresentation( SfxItemPresentation ePresentation,
 250                                   MapUnit, MapUnit,
 251                                   OUString& rText,
 252                                   const IntlWrapper& ) const override;
 253
 254     virtual bool                QueryValue( css::uno::Any& rAny, sal_uInt8 nMemberId = 0 ) const override;
 255     virtual bool                PutValue( const css::uno::Any& rAny, sal_uInt8 nMemberId ) override;
 256
 257 private:
 258     sal_uInt16                  mnWidth;
 259     sal_uInt16                  mnHeight;
 260 };
 261
 262 class ScCondFormatItem : public SfxPoolItem
 263 {
 264 public:
 265     explicit ScCondFormatItem();
 266     explicit ScCondFormatItem(const std::vector<sal_uInt32>& nIndex);
 267
 268     virtual ~ScCondFormatItem() override;
 269
 270     virtual bool operator==(const SfxPoolItem& rCmp ) const override;
 271     virtual ScCondFormatItem*  Clone( SfxItemPool* = nullptr ) const override;
 272
 273     const std::vector<sal_uInt32>& GetCondFormatData() const { return maIndex;}
 274     void AddCondFormatData( sal_uInt32 nIndex );
 275     void SetCondFormatData( const std::vector<sal_uInt32>& aIndex );
 276
 277     virtual void dumpAsXml(struct _xmlTextWriter* pWriter) const override;
 278
 279 private:
 280     std::vector<sal_uInt32> maIndex;
 281 };
 282
 283 #endif
 284
 285 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */