writerfilter/source/dmapper/NumberingManager.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
  20 #ifndef INCLUDED_WRITERFILTER_SOURCE_DMAPPER_NUMBERINGMANAGER_HXX
  21 #define INCLUDED_WRITERFILTER_SOURCE_DMAPPER_NUMBERINGMANAGER_HXX
  22
  23 #include "PropertyMap.hxx"
  24
  25 #include "DomainMapper.hxx"
  26 #include "LoggedResources.hxx"
  27
  28 #include <editeng/numitem.hxx>
  29
  30 #include <com/sun/star/container/XIndexReplace.hpp>
  31 #include <com/sun/star/graphic/XGraphic.hpp>
  32 #include <com/sun/star/awt/XBitmap.hpp>
  33
  34 namespace writerfilter {
  35 namespace dmapper {
  36
  37 class DomainMapper;
  38 class StyleSheetEntry;
  39
  40
  41 /** Class representing the numbering level properties.
  42  */
  43 class ListLevel : public PropertyMap
  44 {
  45     sal_Int32                                     m_nIStartAt;       //LN_CT_Lvl_start
  46     sal_Int32                                     m_nNFC;            //LN_CT_Lvl_numFmt
  47     sal_Int16                                     m_nXChFollow;      //LN_IXCHFOLLOW
  48     OUString                               m_sBulletChar;
  49     css::awt::Size                         m_aGraphicSize;
  50     css::uno::Reference<css::awt::XBitmap> m_xGraphicBitmap;
  51     sal_Int32                                     m_nTabstop;
  52     tools::SvRef< StyleSheetEntry >          m_pParaStyle;
  53     bool                                          m_outline;
  54     bool m_bHasValues = false;
  55
  56 public:
  57
  58     typedef tools::SvRef< ListLevel > Pointer;
  59
  60     ListLevel() :
  61         m_nIStartAt(-1)
  62         ,m_nNFC(-1)
  63         ,m_nXChFollow(SvxNumberFormat::LISTTAB)
  64         ,m_nTabstop( 0 )
  65         ,m_outline(false)
  66         {}
  67
  68     // Setters for the import
  69     void SetValue( Id nId, sal_Int32 nValue );
  70     void SetBulletChar( const OUString& sValue ) { m_sBulletChar = sValue; };
  71     void SetGraphicSize( const css::awt::Size& aValue ) { m_aGraphicSize = aValue; };
  72
  73     void SetGraphicBitmap(css::uno::Reference<css::awt::XBitmap> const& xGraphicBitmap)
  74         { m_xGraphicBitmap = xGraphicBitmap; }
  75     void SetParaStyle( const tools::SvRef< StyleSheetEntry >& pStyle );
  76
  77     // Getters
  78     const OUString& GetBulletChar( ) { return m_sBulletChar; };
  79     const tools::SvRef< StyleSheetEntry >& GetParaStyle( ) { return m_pParaStyle; };
  80     bool isOutlineNumbering() const { return m_outline; }
  81     /// Determines if SetValue() was called at least once.
  82     bool HasValues() const;
  83
  84     // UNO mapping functions
  85
  86     // rPrefix and rSuffix are out parameters
  87     static sal_Int16 GetParentNumbering( const OUString& sText, sal_Int16 nLevel,
  88         OUString& rPrefix, OUString& rSuffix );
  89
  90     css::uno::Sequence<css::beans::PropertyValue> GetProperties(bool bDefaults);
  91
  92     css::uno::Sequence<css::beans::PropertyValue> GetCharStyleProperties();
  93 private:
  94
  95     css::uno::Sequence<css::beans::PropertyValue> GetLevelProperties(bool bDefaults);
  96
  97     void AddParaProperties(css::uno::Sequence<css::beans::PropertyValue>* pProps);
  98 };
  99
 100 /// Represents a numbering picture bullet: an id and a graphic.
 101 class NumPicBullet final : public virtual SvRefBase
 102 {
 103 public:
 104     typedef tools::SvRef<NumPicBullet> Pointer;
 105     NumPicBullet();
 106     ~NumPicBullet() override;
 107
 108     void SetId(sal_Int32 nId);
 109     sal_Int32 GetId() { return m_nId;}
 110     void SetShape(css::uno::Reference<css::drawing::XShape> const& xShape);
 111     const css::uno::Reference<css::drawing::XShape>& GetShape() { return m_xShape; }
 112 private:
 113     sal_Int32 m_nId;
 114     css::uno::Reference<css::drawing::XShape> m_xShape;
 115 };
 116
 117 class AbstractListDef : public virtual SvRefBase
 118 {
 119 private:
 120     // The ID member reflects either the abstractNumId or the numId
 121     // depending on the use of the class
 122     sal_Int32                            m_nId;
 123
 124     // Properties of each level. This can also reflect the overridden
 125     // levels of a numbering.
 126     ::std::vector< ListLevel::Pointer >  m_aLevels;
 127
 128     // Only used during the numberings import
 129     ListLevel::Pointer                         m_pCurrentLevel;
 130
 131     // The style name linked to.
 132     OUString                      m_sNumStyleLink;
 133
 134 public:
 135     typedef tools::SvRef< AbstractListDef > Pointer;
 136
 137     AbstractListDef( );
 138     virtual ~AbstractListDef( ) override;
 139
 140     // Setters using during the import
 141     void SetId( sal_Int32 nId ) { m_nId = nId; };
 142     static void SetValue( sal_uInt32 nSprmId );
 143
 144     // Accessors
 145     sal_Int32             GetId( ) { return m_nId; };
 146
 147     sal_Int16             Size( ) { return sal_Int16( m_aLevels.size( ) ); };
 148     ListLevel::Pointer    GetLevel( sal_uInt16 nLvl );
 149     void                  AddLevel( );
 150
 151     const ListLevel::Pointer&  GetCurrentLevel( ) { return m_pCurrentLevel; };
 152
 153     css::uno::Sequence< css::uno::Sequence<css::beans::PropertyValue> > GetPropertyValues(bool bDefaults);
 154
 155     void                  SetNumStyleLink(const OUString& sValue) { m_sNumStyleLink = sValue; };
 156     const OUString&       GetNumStyleLink() { return m_sNumStyleLink; };
 157 };
 158
 159 class ListDef : public AbstractListDef
 160 {
 161 private:
 162     // Pointer to the abstract numbering
 163     AbstractListDef::Pointer             m_pAbstractDef;
 164
 165     // Cache for the UNO numbering rules
 166     css::uno::Reference< css::container::XIndexReplace > m_xNumRules;
 167
 168 public:
 169     typedef tools::SvRef< ListDef > Pointer;
 170
 171     ListDef( );
 172     virtual ~ListDef( ) override;
 173
 174     // Accessors
 175     void SetAbstractDefinition( AbstractListDef::Pointer pAbstract ) { m_pAbstractDef = pAbstract; };
 176     const AbstractListDef::Pointer& GetAbstractDefinition( ) { return m_pAbstractDef; };
 177
 178     // Mapping functions
 179     static OUString GetStyleName( sal_Int32 nId );
 180
 181     css::uno::Sequence< css::uno::Sequence<css::beans::PropertyValue> > GetMergedPropertyValues();
 182
 183     void CreateNumberingRules(DomainMapper& rDMapper, css::uno::Reference<css::lang::XMultiServiceFactory> const& xFactory);
 184
 185     const css::uno::Reference<css::container::XIndexReplace>& GetNumberingRules() { return m_xNumRules; }
 186
 187 };
 188
 189 /** This class provides access to the defined numbering styles.
 190   */
 191 class ListsManager :
 192     public LoggedProperties,
 193     public LoggedTable
 194 {
 195 private:
 196
 197     DomainMapper&                                       m_rDMapper;
 198     css::uno::Reference<css::lang::XMultiServiceFactory> m_xFactory;
 199
 200     // The numbering entries
 201     std::vector< NumPicBullet::Pointer >                m_aNumPicBullets;
 202     std::vector< AbstractListDef::Pointer >             m_aAbstractLists;
 203     std::vector< ListDef::Pointer >                     m_aLists;
 204
 205
 206     // These members are used for import only
 207     AbstractListDef::Pointer                            m_pCurrentDefinition;
 208     NumPicBullet::Pointer                               m_pCurrentNumPicBullet;
 209
 210     AbstractListDef::Pointer    GetAbstractList( sal_Int32 nId );
 211
 212     // Properties
 213     virtual void lcl_attribute( Id nName, Value & rVal ) override;
 214     virtual void lcl_sprm(Sprm & sprm) override;
 215
 216     // Table
 217     virtual void lcl_entry(int pos, writerfilter::Reference<Properties>::Pointer_t ref) override;
 218
 219 public:
 220
 221     ListsManager(DomainMapper& rDMapper, const css::uno::Reference<css::lang::XMultiServiceFactory>& xFactory);
 222     virtual ~ListsManager() override;
 223
 224     typedef tools::SvRef< ListsManager >  Pointer;
 225
 226     ListDef::Pointer        GetList( sal_Int32 nId );
 227
 228     // Mapping methods
 229     void CreateNumberingRules( );
 230
 231     // Dispose the NumPicBullets
 232     void DisposeNumPicBullets( );
 233 };
 234
 235 } }
 236
 237 #endif
 238
 239 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */