include/editeng/tstpitem.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_EDITENG_TSTPITEM_HXX
  20 #define INCLUDED_EDITENG_TSTPITEM_HXX
  21
  22 #include <svl/poolitem.hxx>
  23 #include <editeng/svxenum.hxx>
  24 #include <editeng/editengdllapi.h>
  25 #include <o3tl/sorted_vector.hxx>
  26
  27 // class SvxTabStop ------------------------------------------------------
  28
  29 #define SVX_TAB_DEFCOUNT    10
  30 #define SVX_TAB_DEFDIST     1134            // 2cm in twips
  31 #define SVX_TAB_NOTFOUND    USHRT_MAX
  32 #define cDfltDecimalChar    u'\0' // Get from IntlWrapper
  33 #define cDfltFillChar       u' '
  34
  35 class EDITENG_DLLPUBLIC SvxTabStop
  36 {
  37 private:
  38     sal_Int32       nTabPos;
  39     SvxTabAdjust    eAdjustment;
  40     sal_Unicode     m_cDecimal;
  41     sal_Unicode     cFill;
  42
  43     void fillDecimal();
  44
  45 public:
  46     SvxTabStop();
  47     explicit SvxTabStop( const sal_Int32 nPos,
  48                 const SvxTabAdjust eAdjst = SvxTabAdjust::Left,
  49                 const sal_Unicode cDec = cDfltDecimalChar,
  50                 const sal_Unicode cFil = cDfltFillChar );
  51
  52     sal_Int32&    GetTabPos() { return nTabPos; }
  53     sal_Int32     GetTabPos() const { return nTabPos; }
  54
  55     SvxTabAdjust& GetAdjustment() { return eAdjustment; }
  56     SvxTabAdjust  GetAdjustment() const { return eAdjustment; }
  57
  58     sal_Unicode&  GetDecimal() { return m_cDecimal; }
  59     sal_Unicode   GetDecimal() const { return m_cDecimal; }
  60
  61     sal_Unicode&  GetFill() { return cFill; }
  62     sal_Unicode   GetFill() const { return cFill; }
  63
  64     bool          operator==( const SvxTabStop& rTS ) const
  65                         {
  66                             return ( nTabPos     == rTS.nTabPos     &&
  67                                      eAdjustment == rTS.eAdjustment &&
  68                                      m_cDecimal    == rTS.m_cDecimal    &&
  69                                      cFill       == rTS.cFill );
  70                         }
  71     bool          operator!=( const SvxTabStop& rTS ) const
  72                         {
  73                             return !operator==(rTS);
  74                         }
  75     // For the SortedArray:
  76     bool            operator <( const SvxTabStop& rTS ) const
  77                         { return nTabPos < rTS.nTabPos; }
  78
  79     void dumpAsXml(xmlTextWriterPtr pWriter) const;
  80 };
  81
  82 // class SvxTabStopItem --------------------------------------------------
  83
  84 typedef o3tl::sorted_vector<SvxTabStop> SvxTabStopArr;
  85
  86 /*  [Description]
  87
  88     This item describes a list of TabStops.
  89 */
  90
  91 class EDITENG_DLLPUBLIC SvxTabStopItem final : public SfxPoolItem
  92 {
  93     SvxTabStopArr maTabStops;
  94     /// Defines default tab width for tabs without dedicated tab stop in the paragraph.
  95     sal_Int32 mnDefaultDistance = 0;
  96
  97 public:
  98     static SfxPoolItem* CreateDefault();
  99
 100     explicit SvxTabStopItem( sal_uInt16 nWhich  );
 101     SvxTabStopItem( const sal_uInt16 nTabs,
 102                     const sal_uInt16 nDist,
 103                     const SvxTabAdjust eAdjst /*= SvxTabAdjust::Default*/,
 104                     sal_uInt16 nWhich  );
 105
 106     // Returns index of the tab or TAB_NOTFOUND
 107     sal_uInt16          GetPos( const SvxTabStop& rTab ) const;
 108
 109     // Returns index of the tab at nPos, or TAB_NOTFOUND
 110     sal_uInt16          GetPos( const sal_Int32 nPos ) const;
 111     void SetDefaultDistance(sal_Int32 nDefaultDistancenDefTabSize);
 112     sal_Int32 GetDefaultDistance() const;
 113
 114     // unprivatized:
 115     sal_uInt16          Count() const { return maTabStops.size(); }
 116     bool                Insert( const SvxTabStop& rTab );
 117     void                Insert( const SvxTabStopItem* pTabs );
 118     void                Remove( const sal_uInt16 nPos, const sal_uInt16 nLen = 1 )
 119                         { ASSERT_CHANGE_REFCOUNTED_ITEM; maTabStops.erase( maTabStops.begin() + nPos, maTabStops.begin() + nPos + nLen ); }
 120
 121     // Assignment operator, equality operator (caution: expensive!)
 122
 123     // this is already included in SfxPoolItem declaration
 124     //int             operator!=( const SvxTabStopItem& rTSI ) const
 125     //                  { return !( operator==( rTSI ) ); }
 126
 127     const SvxTabStop& operator[]( const sal_uInt16 nPos ) const
 128                         { return maTabStops[nPos]; }
 129
 130     const SvxTabStop& At( const sal_uInt16 nPos ) const
 131     {
 132         return maTabStops[nPos];
 133     }
 134
 135     // "pure virtual Methods" from SfxPoolItem
 136     virtual bool             operator==( const SfxPoolItem& ) const override;
 137     virtual bool             supportsHashCode() const override { return true; }
 138     virtual size_t           hashCode() const override final;
 139     virtual bool             QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
 140     virtual bool             PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
 141
 142     virtual bool GetPresentation( SfxItemPresentation ePres,
 143                                   MapUnit eCoreMetric,
 144                                   MapUnit ePresMetric,
 145                                   OUString &rText, const IntlWrapper& ) const override;
 146
 147     virtual SvxTabStopItem* Clone( SfxItemPool *pPool = nullptr ) const override;
 148
 149     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
 150 };
 151
 152 #endif
 153
 154 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */