include/editeng/escapementitem.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_ESCAPEMENTITEM_HXX
  20 #define INCLUDED_EDITENG_ESCAPEMENTITEM_HXX
  21
  22 #include <svl/cenumitm.hxx>
  23 #include <editeng/svxenum.hxx>
  24 #include <editeng/editengdllapi.h>
  25
  26 // class SvxEscapementItem -----------------------------------------------
  27
  28 #define DFLT_ESC_SUPER   33     // 1/3
  29 #define DFLT_ESC_SUB    -33     // also 1/3 previously 8/100
  30 #define DFLT_ESC_PROP    58
  31 #define DFLT_ESC_AUTO_SUPER 101
  32 #define DFLT_ESC_AUTO_SUB  -101
  33
  34 /*  [Description]
  35
  36     This item describes the writing position.
  37 */
  38
  39 class EDITENG_DLLPUBLIC SvxEscapementItem : public SfxEnumItemInterface
  40 {
  41     short nEsc;
  42     sal_uInt8  nProp;
  43 public:
  44     static SfxPoolItem* CreateDefault();
  45
  46     explicit SvxEscapementItem( const sal_uInt16 nId  );
  47     SvxEscapementItem( const SvxEscapement eEscape,
  48                    const sal_uInt16 nId  );
  49     SvxEscapementItem( const short nEsc, const sal_uInt8 nProp,
  50                    const sal_uInt16 nId  );
  51
  52     // "pure virtual Methods" from SfxPoolItem
  53     virtual bool             operator==( const SfxPoolItem& ) const override;
  54     virtual bool GetPresentation( SfxItemPresentation ePres,
  55                                     MapUnit eCoreMetric,
  56                                     MapUnit ePresMetric,
  57                                     OUString &rText, const IntlWrapper& ) const override;
  58
  59     virtual bool             QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  60     virtual bool             PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  61
  62     virtual SfxPoolItem*     Clone( SfxItemPool *pPool = nullptr ) const override;
  63
  64     void SetEscapement( const SvxEscapement eNew )
  65     {
  66         if( SvxEscapement::Off == eNew )
  67         {
  68             nEsc = 0;
  69             nProp = 100;
  70         }
  71         else
  72             if( SvxEscapement::Superscript == eNew )
  73             {
  74                 nEsc = DFLT_ESC_SUPER;
  75                 nProp = DFLT_ESC_PROP;
  76             }
  77             else
  78             {
  79                 nEsc = DFLT_ESC_SUB;
  80                 nProp = DFLT_ESC_PROP;
  81             }
  82     }
  83     SvxEscapement GetEscapement() const { return static_cast< SvxEscapement >( GetEnumValue() ); }
  84
  85     short &GetEsc() { return nEsc; }
  86     short GetEsc() const { return nEsc; }
  87
  88     sal_uInt8 &GetProportionalHeight() { return nProp; }
  89     sal_uInt8  GetProportionalHeight() const { return nProp; }
  90
  91     virtual sal_uInt16      GetValueCount() const override;
  92     static OUString         GetValueTextByPos( sal_uInt16 nPos );
  93     virtual sal_uInt16      GetEnumValue() const override;
  94     virtual void            SetEnumValue( sal_uInt16 nNewVal ) override;
  95 };
  96
  97 #endif
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */