sw/inc/swmodule.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_SW_INC_SWMODULE_HXX
  20 #define INCLUDED_SW_INC_SWMODULE_HXX
  21
  22 #include <sal/config.h>
  23
  24 #include <cstddef>
  25
  26 #include <tools/fldunit.hxx>
  27 #include <svl/lstner.hxx>
  28 #include <unotools/options.hxx>
  29 #include <sfx2/module.hxx>
  30
  31 #include "swdllapi.h"
  32 #include "shellid.hxx"
  33 #include <fldupde.hxx>
  34 #include <com/sun/star/linguistic2/XLinguServiceEventListener.hpp>
  35 #include <com/sun/star/linguistic2/XLanguageGuessing.hpp>
  36
  37 class Color;
  38 class SfxItemSet;
  39 class SfxRequest;
  40 class SfxErrorHandler;
  41 class SwDBConfig;
  42 class SwModuleOptions;
  43 class SwMasterUsrPref;
  44 class SwViewOption;
  45 class SwView;
  46 class SwWrtShell;
  47 class SwPrintOptions;
  48 class SwChapterNumRules;
  49 class SwStdFontConfig;
  50 class SwNavigationConfig;
  51 class SwTransferable;
  52 class SwToolbarConfigItem;
  53 class SwAttrPool;
  54 namespace svtools{ class ColorConfig;}
  55 class SvtAccessibilityOptions;
  56 class SvtCTLOptions;
  57 class SvtUserOptions;
  58 enum class SwCompareMode;
  59 struct SwDBData;
  60
  61 enum class SvViewOpt {
  62     DestView,
  63     DestText,
  64     DestWeb,
  65     DestViewOnly   //ViewOptions are set only at View, not at the appl.
  66 };
  67
  68 namespace com{ namespace sun{ namespace star{ namespace scanner{
  69     class XScannerManager2;
  70 }}}}
  71
  72 class SW_DLLPUBLIC SwModule: public SfxModule, public SfxListener, public utl::ConfigurationListener
  73 {
  74     OUString            m_sActAuthor;
  75
  76     // ConfigItems
  77     SwModuleOptions*    m_pModuleConfig;
  78     SwMasterUsrPref*    m_pUsrPref;
  79     SwMasterUsrPref*    m_pWebUsrPref;
  80     SwPrintOptions*     m_pPrintOptions;
  81     SwPrintOptions*     m_pWebPrintOptions;
  82     SwChapterNumRules*  m_pChapterNumRules;
  83     SwStdFontConfig*    m_pStdFontConfig;
  84     SwNavigationConfig* m_pNavigationConfig;
  85     SwToolbarConfigItem*m_pToolbarConfig;     //For stacked toolbars. Which one was visible?
  86     SwToolbarConfigItem*m_pWebToolbarConfig;
  87     SwDBConfig*         m_pDBConfig;
  88     svtools::ColorConfig*   m_pColorConfig;
  89     SvtAccessibilityOptions* m_pAccessibilityOptions;
  90     SvtCTLOptions*      m_pCTLOptions;
  91     SvtUserOptions*     m_pUserOptions;
  92
  93     SfxErrorHandler*    m_pErrorHandler;
  94
  95     SwAttrPool          *m_pAttrPool;
  96
  97     // Current view is held here in order to avoid one's being forced
  98     // to work via GetActiveView.
  99     // View is valid until destroyed in Activate or exchanged.
 100     SwView*             m_pView;
 101
 102     // List of all Redline-authors.
 103     std::vector<OUString> m_pAuthorNames;
 104
 105     // DictionaryList listener to trigger spellchecking or hyphenation
 106     css::uno::Reference< css::linguistic2::XLinguServiceEventListener > m_xLinguServiceEventListener;
 107     css::uno::Reference< css::scanner::XScannerManager2 >    m_xScannerManager;
 108     css::uno::Reference< css::linguistic2::XLanguageGuessing >  m_xLanguageGuesser;
 109
 110     bool                m_bAuthorInitialised : 1;
 111     bool                m_bEmbeddedLoadSave : 1;
 112
 113     // Catch hint for DocInfo.
 114     virtual void        Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) override;
 115
 116     virtual void        ConfigurationChanged( utl::ConfigurationBroadcaster*, ConfigurationHints ) override;
 117
 118 protected:
 119     // Envelopes, labels.
 120     void                InsertEnv(SfxRequest&);
 121     void                InsertLab(SfxRequest&, bool bLabel);
 122
 123 public:
 124     // public Data - used for internal Clipboard / Drag & Drop / XSelection
 125     SwTransferable  *m_pDragDrop, *m_pXSelection;
 126
 127     SFX_DECL_INTERFACE(SW_INTERFACE_MODULE)
 128
 129 private:
 130     /// SfxInterface initializer.
 131     static void InitInterface_Impl();
 132
 133 public:
 134     // This Ctor only for SW-Dll.
 135     SwModule( SfxObjectFactory* pFact,
 136                 SfxObjectFactory* pWebFact,
 137                     SfxObjectFactory* pGlobalFact );
 138
 139     virtual ~SwModule() override;
 140
 141     // Set view for internal use only. It is public only for technical reasons.
 142     void        SetView(SwView* pVw) { m_pView = pVw; }
 143     SwView*     GetView() { return m_pView; }
 144
 145     // Handler for slots.
 146     void                StateOther(SfxItemSet &);
 147
 148     void                ExecOther(SfxRequest &);    // Fields, formula...
 149
 150     // Modify user settings.
 151     const SwMasterUsrPref *GetUsrPref(bool bWeb) const;
 152     const SwViewOption* GetViewOption(bool bWeb);
 153     void                ApplyUsrPref(const SwViewOption &, SwView*,
 154                                      SvViewOpt nDest = SvViewOpt::DestView );
 155     void ApplyUserMetric( FieldUnit eMetric, bool bWeb );
 156     void ApplyRulerMetric( FieldUnit eMetric, bool bHorizontal, bool bWeb );
 157     void ApplyFieldUpdateFlags(SwFieldUpdateFlags eFieldFlags);
 158     void ApplyLinkMode(sal_Int32 nNewLinkMode);
 159
 160     // Default page mode for text grid.
 161     void ApplyDefaultPageMode(bool bIsSquaredPageMode);
 162
 163     void ApplyUserCharUnit(bool bApplyChar, bool bWeb);  // apply_char_unit
 164
 165     // Create ConfigItems.
 166     SwModuleOptions*    GetModuleConfig()       { return m_pModuleConfig;}
 167     SwPrintOptions*     GetPrtOptions(bool bWeb);
 168     SwChapterNumRules*  GetChapterNumRules();
 169     SwStdFontConfig*    GetStdFontConfig()      { return m_pStdFontConfig; }
 170     SwNavigationConfig* GetNavigationConfig();
 171     SwToolbarConfigItem*GetToolbarConfig()      { return m_pToolbarConfig;    }
 172     SwToolbarConfigItem*GetWebToolbarConfig()   { return m_pWebToolbarConfig; }
 173     SwDBConfig*         GetDBConfig();
 174     svtools::ColorConfig&   GetColorConfig();
 175     SvtAccessibilityOptions&    GetAccessibilityOptions();
 176     SvtCTLOptions&      GetCTLOptions();
 177     SvtUserOptions&     GetUserOptions();
 178
 179     // Iterate over views.
 180     static SwView*      GetFirstView();
 181     static SwView*      GetNextView(SwView*);
 182
 183     bool IsEmbeddedLoadSave() const         { return m_bEmbeddedLoadSave; }
 184     void SetEmbeddedLoadSave( bool bFlag )  { m_bEmbeddedLoadSave = bFlag; }
 185
 186     static void ShowDBObj( SwView& rView, const SwDBData& rData);
 187
 188     // Table modi.
 189     bool            IsInsTableFormatNum(bool bHTML) const;
 190     bool            IsInsTableChangeNumFormat(bool bHTML) const;
 191     bool            IsInsTableAlignNum(bool bHTML) const;
 192
 193     // Redlining.
 194     std::size_t         GetRedlineAuthor();
 195     OUString            GetRedlineAuthor(std::size_t nPos);
 196     /// See SwXTextDocument::getTrackedChangeAuthors().
 197     OUString GetRedlineAuthorInfo();
 198     std::size_t         InsertRedlineAuthor(const OUString& rAuthor);
 199     void                SetRedlineAuthor(const OUString& rAuthor); // for unit tests
 200
 201     void                GetInsertAuthorAttr(std::size_t nAuthor, SfxItemSet &rSet);
 202     void                GetDeletedAuthorAttr(std::size_t nAuthor, SfxItemSet &rSet);
 203     void                GetFormatAuthorAttr(std::size_t nAuthor, SfxItemSet &rSet);
 204
 205     sal_uInt16              GetRedlineMarkPos();
 206     const Color&            GetRedlineMarkColor();
 207
 208     SwCompareMode      GetCompareMode() const;
 209     bool            IsUseRsid() const;
 210     bool            IsIgnorePieces() const;
 211     sal_uInt16          GetPieceLen() const;
 212
 213     // Return defined DocStat - WordDelimiter.
 214     OUString            GetDocStatWordDelim() const;
 215
 216     // Pass metric of ModuleConfig (for HTML-export).
 217     FieldUnit GetMetric( bool bWeb ) const;
 218
 219     // Pass update-statuses.
 220     sal_uInt16 GetLinkUpdMode() const;
 221     SwFieldUpdateFlags GetFieldUpdateFlags() const;
 222
 223     // Virtual methods for options dialog.
 224     virtual SfxItemSet*  CreateItemSet( sal_uInt16 nId ) override;
 225     virtual void         ApplyItemSet( sal_uInt16 nId, const SfxItemSet& rSet ) override;
 226     virtual VclPtr<SfxTabPage> CreateTabPage( sal_uInt16 nId, vcl::Window* pParent, const SfxItemSet& rSet ) override;
 227     virtual SfxStyleFamilies* CreateStyleFamilies() override;
 228
 229     // Pool is created here and set at SfxShell.
 230     void    InitAttrPool();
 231     // Delete pool before it is too late.
 232     void    RemoveAttrPool();
 233
 234     // Invalidates online spell-wrong-lists if necessary.
 235     static void  CheckSpellChanges( bool bOnlineSpelling,
 236                     bool bIsSpellWrongAgain, bool bIsSpellAllAgain, bool bSmartTags );
 237
 238     inline const css::uno::Reference< css::linguistic2::XLinguServiceEventListener >&
 239             GetLngSvcEvtListener();
 240     void    CreateLngSvcEvtListener();
 241
 242     css::uno::Reference< css::scanner::XScannerManager2 > const &
 243             GetScannerManager();
 244
 245     css::uno::Reference< css::linguistic2::XLanguageGuessing > const &
 246             GetLanguageGuesser();
 247 };
 248
 249 inline const css::uno::Reference< css::linguistic2::XLinguServiceEventListener >&
 250         SwModule::GetLngSvcEvtListener()
 251 {
 252     return m_xLinguServiceEventListener;
 253 }
 254
 255 //    Access to SwModule, the View and the shell.
 256
 257 #define SW_MOD() ( static_cast<SwModule*>(SfxApplication::GetModule(SfxToolsModule::Writer)))
 258
 259 SW_DLLPUBLIC SwView*    GetActiveView();
 260 SW_DLLPUBLIC SwWrtShell* GetActiveWrtShell();
 261
 262 namespace sw
 263 {
 264 SW_DLLPUBLIC Color* GetActiveRetoucheColor();
 265 }
 266
 267 extern bool g_bNoInterrupt;
 268
 269 #endif
 270
 271 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */