include/editeng/bulletitem.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_BULLETITEM_HXX
  20 #define INCLUDED_EDITENG_BULLETITEM_HXX
  21
  22 #include <memory>
  23 #include <editeng/editengdllapi.h>
  24 #include <svl/poolitem.hxx>
  25 #include <svtools/grfmgr.hxx>
  26 #include <vcl/font.hxx>
  27
  28
  29 /**
  30  * these must match the values in css::style::NumberingType
  31  */
  32 enum class SvxBulletStyle
  33 {
  34     ABC_BIG          = 0,
  35     ABC_SMALL        = 1,
  36     ROMAN_BIG        = 2,
  37     ROMAN_SMALL      = 3,
  38     N123             = 4,
  39     NONE             = 5,
  40     BULLET           = 6,
  41     BMP              = 128
  42 };
  43
  44 // class SvxBulletItem ---------------------------------------------------
  45
  46 class EDITENG_DLLPUBLIC SvxBulletItem : public SfxPoolItem
  47 {
  48     vcl::Font       aFont;
  49     std::unique_ptr<GraphicObject>
  50                     pGraphicObject;
  51     OUString        aPrevText;
  52     OUString        aFollowText;
  53     sal_uInt16      nStart;
  54     SvxBulletStyle  nStyle;
  55     long            nWidth;
  56     sal_uInt16      nScale;
  57     sal_Unicode     cSymbol;
  58
  59     void    SetDefaultFont_Impl();
  60     void    SetDefaults_Impl();
  61
  62 public:
  63     explicit SvxBulletItem( sal_uInt16 nWhich );
  64     explicit SvxBulletItem( SvStream& rStrm, sal_uInt16 nWhich );
  65     SvxBulletItem( const SvxBulletItem& );
  66     virtual ~SvxBulletItem() override;
  67
  68     virtual SfxPoolItem*    Clone( SfxItemPool *pPool = nullptr ) const override;
  69     virtual SfxPoolItem*    Create( SvStream&, sal_uInt16 nVersion ) const override;
  70     virtual SvStream&       Store( SvStream & , sal_uInt16 nItemVersion ) const override;
  71
  72     OUString            GetFullText() const;
  73
  74     long                GetWidth() const { return nWidth; }
  75     const vcl::Font&    GetFont() const { return aFont; }
  76
  77     const GraphicObject& GetGraphicObject() const;
  78     void                 SetGraphicObject( const GraphicObject& rGraphicObject );
  79
  80     void                SetSymbol( sal_Unicode c) { cSymbol = c; }
  81
  82     void                SetStart( sal_uInt16 nNew ) { nStart = nNew; }
  83     void                SetWidth( long nNew ) { nWidth = nNew; }
  84     void                SetStyle( SvxBulletStyle nNew ) { nStyle = nNew; }
  85     void                SetFont( const vcl::Font& rNew) { aFont = rNew; }
  86     void                SetScale( sal_uInt16 nNew ) { nScale = nNew; }
  87
  88     virtual sal_uInt16  GetVersion(sal_uInt16 nFileVersion) const override;
  89     virtual bool        operator==( const SfxPoolItem& ) const override;
  90     virtual bool        GetPresentation( SfxItemPresentation ePres,
  91                                     MapUnit eCoreMetric,
  92                                     MapUnit ePresMetric,
  93                                     OUString &rText, const IntlWrapper * = nullptr ) const override;
  94
  95     static void         StoreFont( SvStream&, const vcl::Font& );
  96     static vcl::Font    CreateFont( SvStream&, sal_uInt16 nVer );
  97
  98     void                CopyValidProperties( const SvxBulletItem& rCopyFrom );
  99 };
 100
 101
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */