sw/inc/tgrditem.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_TGRDITEM_HXX
  20 #define INCLUDED_SW_INC_TGRDITEM_HXX
  21
  22 #include <tools/color.hxx>
  23 #include <svl/poolitem.hxx>
  24 #include "swdllapi.h"
  25 #include "hintids.hxx"
  26 #include "format.hxx"
  27
  28 class IntlWrapper;
  29
  30 enum SwTextGrid { GRID_NONE, GRID_LINES_ONLY, GRID_LINES_CHARS };
  31
  32 class SW_DLLPUBLIC SwTextGridItem : public SfxPoolItem
  33 {
  34 private:
  35     Color m_aColor;
  36     sal_uInt16 m_nLines;
  37     sal_uInt16 m_nBaseHeight;
  38     sal_uInt16 m_nRubyHeight;
  39     SwTextGrid m_eGridType;
  40     bool m_bRubyTextBelow;
  41     bool m_bPrintGrid;
  42     bool m_bDisplayGrid;
  43
  44     //for textgrid enhancement
  45     sal_uInt16 m_nBaseWidth;
  46     bool m_bSnapToChars;
  47     bool m_bSquaredMode;
  48
  49 public:
  50     SwTextGridItem();
  51     virtual ~SwTextGridItem() override;
  52
  53     SwTextGridItem(SwTextGridItem const &) = default;
  54     SwTextGridItem(SwTextGridItem &&) = default;
  55     SwTextGridItem & operator =(SwTextGridItem const &) = delete; // due to SfxPoolItem
  56     SwTextGridItem & operator =(SwTextGridItem &&) = delete; // due to SfxPoolItem
  57
  58     // "pure virtual methods" of SfxPoolItem
  59     virtual bool            operator==( const SfxPoolItem& ) const override;
  60     virtual SfxPoolItem*    Clone( SfxItemPool* pPool = nullptr ) const override;
  61     virtual bool GetPresentation( SfxItemPresentation ePres,
  62                                   MapUnit eCoreMetric,
  63                                   MapUnit ePresMetric,
  64                                   OUString &rText,
  65                                   const IntlWrapper& rIntl ) const override;
  66     virtual bool             QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  67     virtual bool             PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  68
  69     const Color& GetColor() const { return m_aColor; }
  70     void SetColor( const Color& rCol )  { m_aColor = rCol; }
  71
  72     sal_uInt16 GetLines() const { return m_nLines; }
  73     void SetLines( sal_uInt16 nNew ) { m_nLines = nNew; }
  74
  75     sal_uInt16 GetBaseHeight() const { return m_nBaseHeight; }
  76     void SetBaseHeight( sal_uInt16 nNew ) { m_nBaseHeight = nNew; }
  77
  78     sal_uInt16 GetRubyHeight() const { return m_nRubyHeight; }
  79     void SetRubyHeight( sal_uInt16 nNew ) { m_nRubyHeight = nNew; }
  80
  81     SwTextGrid GetGridType() const { return m_eGridType; }
  82     void SetGridType( SwTextGrid eNew ) { m_eGridType = eNew; }
  83
  84     bool IsRubyTextBelow() const { return m_bRubyTextBelow; }
  85     bool GetRubyTextBelow() const { return m_bRubyTextBelow; }
  86     void SetRubyTextBelow( bool bNew ) { m_bRubyTextBelow = bNew; }
  87
  88     bool IsPrintGrid() const { return m_bPrintGrid; }
  89     bool GetPrintGrid() const { return m_bPrintGrid; }
  90     void SetPrintGrid( bool bNew ) { m_bPrintGrid = bNew; }
  91
  92     bool IsDisplayGrid() const { return m_bDisplayGrid; }
  93     bool GetDisplayGrid() const { return m_bDisplayGrid; }
  94     void SetDisplayGrid( bool bNew ) { m_bDisplayGrid = bNew; }
  95
  96     //for textgrid enhancement
  97     sal_uInt16 GetBaseWidth() const { return m_nBaseWidth;}
  98     void SetBaseWidth( sal_uInt16 nNew ) { m_nBaseWidth = nNew; }
  99
 100     bool IsSnapToChars() const { return m_bSnapToChars; }
 101     bool GetSnapToChars() const { return m_bSnapToChars; }
 102     void SetSnapToChars( bool bNew ) { m_bSnapToChars = bNew; }
 103
 104     bool IsSquaredMode() const { return m_bSquaredMode; }
 105     bool GetSquaredMode() const { return m_bSquaredMode; }
 106     void SetSquaredMode( bool bNew ) { m_bSquaredMode = bNew; }
 107     void SwitchPaperMode(bool bNew );
 108
 109     void Init();
 110 };
 111
 112 inline const SwTextGridItem &SwFormat::GetTextGrid(bool bInP) const
 113     {   return m_aSet.Get( RES_TEXTGRID, bInP ); }
 114
 115 #endif
 116
 117 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */