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