include/editeng/udlnitem.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_UDLNITEM_HXX
  20 #define INCLUDED_EDITENG_UDLNITEM_HXX
  21
  22 #include <svl/eitem.hxx>
  23 #include <tools/color.hxx>
  24 #include <tools/fontenum.hxx>
  25 #include <editeng/editengdllapi.h>
  26
  27 // class SvxTextLineItem ------------------------------------------------
  28
  29 /* Value container for underline and overline font effects */
  30
  31 class EDITENG_DLLPUBLIC SvxTextLineItem : public SfxEnumItem<FontLineStyle>
  32 {
  33     Color mColor;
  34 public:
  35     SvxTextLineItem( const FontLineStyle eSt,
  36                      const sal_uInt16 nId );
  37
  38     // "pure virtual Methods" from SfxPoolItem
  39     virtual bool GetPresentation( SfxItemPresentation ePres,
  40                                   MapUnit eCoreMetric,
  41                                   MapUnit ePresMetric,
  42                                   OUString &rText, const IntlWrapper& ) const override;
  43
  44     virtual SvxTextLineItem* Clone( SfxItemPool *pPool = nullptr ) const override;
  45     virtual OUString        GetValueTextByPos( sal_uInt16 nPos ) const;
  46     virtual sal_uInt16      GetValueCount() const override;
  47
  48     virtual bool            QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const override;
  49     virtual bool            PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId ) override;
  50
  51     using SfxEnumItem::SetValue;
  52     virtual bool            HasBoolValue() const override;
  53     virtual bool            GetBoolValue() const override;
  54     virtual void            SetBoolValue( bool bVal ) override;
  55
  56     virtual bool            operator==( const SfxPoolItem& ) const override;
  57
  58     // enum cast
  59     FontLineStyle           GetLineStyle() const
  60                                 { return GetValue(); }
  61     void                    SetLineStyle( FontLineStyle eNew )
  62                                 { SetValue(eNew); }
  63
  64     const Color&            GetColor() const                { return mColor; }
  65     void                    SetColor( const Color& rCol )   { mColor = rCol; }
  66 };
  67
  68 // class SvxUnderlineItem ------------------------------------------------
  69
  70 /* Value container for underline font effects */
  71
  72 class EDITENG_DLLPUBLIC SvxUnderlineItem final : public SvxTextLineItem
  73 {
  74 public:
  75     static SfxPoolItem* CreateDefault();
  76
  77     SvxUnderlineItem( const FontLineStyle eSt,
  78                       const sal_uInt16 nId );
  79
  80     virtual SvxUnderlineItem* Clone( SfxItemPool *pPool = nullptr ) const override;
  81     virtual OUString   GetValueTextByPos( sal_uInt16 nPos ) const override;
  82 };
  83
  84 // class SvxOverlineItem ------------------------------------------------
  85
  86 /* Value container for overline font effects */
  87
  88 class EDITENG_DLLPUBLIC SvxOverlineItem final : public SvxTextLineItem
  89 {
  90 public:
  91     static SfxPoolItem* CreateDefault();
  92
  93     SvxOverlineItem( const FontLineStyle eSt,
  94                      const sal_uInt16 nId );
  95
  96     virtual SvxOverlineItem* Clone( SfxItemPool *pPool = nullptr ) const override;
  97     virtual OUString   GetValueTextByPos( sal_uInt16 nPos ) const override;
  98 };
  99
 100 #endif // INCLUDED_EDITENG_UDLNITEM_HXX
 101
 102 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */