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