sd/source/ui/inc/DrawDocShell.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 #pragma once
  21
  22 #include <o3tl/span.hxx>
  23 #include <sfx2/docfac.hxx>
  24 #include <sfx2/objsh.hxx>
  25 #include <svl/style.hxx>
  26
  27 #include <glob.hxx>
  28 #include <pres.hxx>
  29 #include <sddllapi.h>
  30 #include "fupoor.hxx"
  31
  32 class FontList;
  33 class SdDrawDocument;
  34 class SdPage;
  35 class SfxPrinter;
  36 struct SpellCallbackInfo;
  37 class AbstractSvxNameDialog;
  38 class SfxUndoManager;
  39
  40 namespace sd {
  41
  42 class FrameView;
  43 class ViewShell;
  44 class DrawViewShell;
  45
  46 // DrawDocShell
  47 class SD_DLLPUBLIC DrawDocShell : public SfxObjectShell
  48 {
  49 public:
  50     SFX_DECL_INTERFACE(SD_IF_SDDRAWDOCSHELL)
  51     SFX_DECL_OBJECTFACTORY();
  52
  53 private:
  54     /// SfxInterface initializer.
  55     static void InitInterface_Impl();
  56
  57 public:
  58     DrawDocShell (
  59         SfxObjectCreateMode eMode,
  60         bool bSdDataObj,
  61         DocumentType);
  62
  63     DrawDocShell (
  64         SfxModelFlags nModelCreationFlags,
  65         bool bSdDataObj,
  66         DocumentType);
  67
  68     DrawDocShell (
  69         SdDrawDocument* pDoc,
  70         SfxObjectCreateMode eMode,
  71         bool bSdDataObj,
  72         DocumentType);
  73     virtual ~DrawDocShell() override;
  74
  75     void                    UpdateRefDevice();
  76     virtual void            Activate( bool bMDI ) override;
  77     virtual void            Deactivate( bool bMDI ) override;
  78     virtual bool            InitNew( const css::uno::Reference< css::embed::XStorage >& xStorage ) override;
  79     virtual bool            ImportFrom(SfxMedium &rMedium,
  80             css::uno::Reference<css::text::XTextRange> const& xInsertPosition)
  81         override;
  82     virtual bool            ConvertFrom( SfxMedium &rMedium ) override;
  83     virtual bool            Save() override;
  84     virtual bool            SaveAsOwnFormat( SfxMedium& rMedium ) override;
  85     virtual bool            ConvertTo( SfxMedium &rMedium ) override;
  86     virtual bool            SaveCompleted( const css::uno::Reference< css::embed::XStorage >& xStorage ) override;
  87
  88     virtual bool            Load( SfxMedium &rMedium  ) override;
  89     virtual bool            LoadFrom( SfxMedium& rMedium ) override;
  90     virtual bool            SaveAs( SfxMedium &rMedium  ) override;
  91
  92     virtual ::tools::Rectangle       GetVisArea(sal_uInt16 nAspect) const override;
  93     virtual void            Draw(OutputDevice*, const JobSetup& rSetup, sal_uInt16 nAspect, bool bOutputForScreen) override;
  94     virtual SfxUndoManager* GetUndoManager() override;
  95     virtual Printer*        GetDocumentPrinter() override;
  96     virtual void            OnDocumentPrinterChanged(Printer* pNewPrinter) override;
  97     virtual SfxStyleSheetBasePool* GetStyleSheetPool() override;
  98     virtual void            FillClass(SvGlobalName* pClassName, SotClipboardFormatId* pFormat, OUString* pFullTypeName, sal_Int32 nFileFormat, bool bTemplate = false ) const override;
  99     virtual void            SetModified( bool = true ) override;
 100     virtual std::shared_ptr<SfxDocumentInfoDialog> CreateDocumentInfoDialog(weld::Window* pParent,
 101                                                                             const SfxItemSet &rSet) override;
 102
 103     using SfxObjectShell::GetVisArea;
 104     using SfxShell::GetViewShell;
 105
 106     sd::ViewShell* GetViewShell() { return mpViewShell; }
 107     ::sd::FrameView* GetFrameView();
 108
 109     SdDrawDocument*         GetDoc() { return mpDoc;}
 110     DocumentType            GetDocumentType() const { return meDocType; }
 111
 112     SfxPrinter*             GetPrinter(bool bCreate);
 113     void                    SetPrinter(SfxPrinter *pNewPrinter);
 114     void                    UpdateFontList();
 115
 116     bool                    IsInDestruction() const { return mbInDestruction; }
 117
 118     void                    CancelSearching();
 119
 120     void                    Execute( SfxRequest& rReq );
 121     void                    GetState(SfxItemSet&);
 122
 123     void                    Connect(sd::ViewShell* pViewSh);
 124     void                    Disconnect(sd::ViewShell const * pViewSh);
 125     void                    UpdateTablePointers();
 126
 127     void                    GotoBookmark(std::u16string_view rBookmark);
 128
 129     BitmapEx                GetPagePreviewBitmap(SdPage* pPage);
 130
 131     /** checks, if the given name is a valid new name for a slide
 132
 133         <p>If the name is invalid, an <type>SvxNameDialog</type> pops up that
 134         queries again for a new name until it is ok or the user chose
 135         Cancel.</p>
 136
 137         @param pWin is necessary to pass to the <type>SvxNameDialog</type> in
 138                     case an invalid name was entered.
 139         @param rName the new name that is to be set for a slide.  This string
 140                      may be set to an empty string (see below).
 141
 142         @return sal_True, if the new name is unique.  Note that if the user entered
 143                 a default name of a not-yet-existing slide (e.g. 'Slide 17'),
 144                 sal_True is returned, but rName is set to an empty string.
 145      */
 146     bool                    CheckPageName(weld::Window* pWin, OUString& rName );
 147
 148     void                    SetSlotFilter(bool bEnable = false, o3tl::span<sal_uInt16 const> pSIDs = o3tl::span<sal_uInt16 const>()) { mbFilterEnable = bEnable; mpFilterSIDs = pSIDs; }
 149     void                    ApplySlotFilter() const;
 150
 151     SfxStyleFamily          GetStyleFamily() const { return mnStyleFamily; }
 152     void                    SetStyleFamily( SfxStyleFamily nSF ) { mnStyleFamily = nSF; }
 153
 154     /** executes the SID_OPENDOC slot to let the framework open a document
 155         with the given URL and this document as a referer */
 156     void                    OpenBookmark( const OUString& rBookmarkURL );
 157
 158     /** checks, if the given name is a valid new name for a slide
 159
 160         <p>This method does not pop up any dialog (like CheckPageName).</p>
 161
 162         @param rInOutPageName the new name for a slide that is to be renamed.
 163                     This string will be set to an empty string if
 164                     bResetStringIfStandardName is true and the name is of the
 165                     form of any, possibly not-yet existing, standard slide
 166                     (e.g. 'Slide 17')
 167
 168         @param bResetStringIfStandardName if true allows setting rInOutPageName
 169                     to an empty string, which returns true and implies that the
 170                     slide will later on get a new standard name (with a free
 171                     slide number).
 172
 173         @return true, if the new name is unique.  If bResetStringIfStandardName
 174                     is true, the return value is also true, if the slide name is
 175                     a standard name (see above)
 176      */
 177     bool                    IsNewPageNameValid( OUString & rInOutPageName, bool bResetStringIfStandardName = false );
 178
 179     /** checks, if the given name is a *unique* name for an *existing* slide
 180
 181         @param rPageName the name of an existing slide
 182
 183         @return true, if the name is unique and the slide exists
 184     */
 185     bool                    IsPageNameUnique(std::u16string_view rPagName) const;
 186
 187     /** Return the reference device for the current document.  When the
 188         inherited implementation returns a device then this is passed to the
 189         caller.  Otherwise the returned value depends on the printer
 190         independent layout mode and will usually be either a printer or a
 191         virtual device used for screen rendering.
 192         @return
 193             Returns NULL when the current document has no reference device.
 194     */
 195     virtual OutputDevice* GetDocumentRefDev() override;
 196
 197     DECL_DLLPRIVATE_LINK( RenameSlideHdl, AbstractSvxNameDialog&, bool );
 198
 199     // ExecuteSpellPopup now handled by DrawDocShell
 200     DECL_DLLPRIVATE_LINK( OnlineSpellCallback, SpellCallbackInfo&, void );
 201
 202     void                    ClearUndoBuffer();
 203
 204     std::shared_ptr<model::ColorSet> GetThemeColors() override;
 205
 206 private:
 207     static void setEditMode(DrawViewShell* pDrawViewShell, bool isMasterPage);
 208     void                    Construct(bool bClipboard);
 209
 210     SdDrawDocument*         mpDoc;
 211     std::unique_ptr<SfxUndoManager> mpUndoManager;
 212     VclPtr<SfxPrinter>      mpPrinter;
 213     ::sd::ViewShell*        mpViewShell;
 214     std::unique_ptr<FontList> mpFontList;
 215     DocumentType            meDocType;
 216     SfxStyleFamily          mnStyleFamily;
 217     o3tl::span<sal_uInt16 const>
 218                             mpFilterSIDs;
 219     bool                    mbFilterEnable;
 220     bool                    mbSdDataObj;
 221     bool                    mbInDestruction;
 222     bool                    mbOwnPrinter;
 223     bool                    mbOwnDocument;          // if true, we own mpDoc and will delete it in our d'tor
 224 };
 225
 226 #ifndef SV_DECL_DRAW_DOC_SHELL_DEFINED
 227 #define SV_DECL_DRAW_DOC_SHELL_DEFINED
 228 typedef ::tools::SvRef<DrawDocShell> DrawDocShellRef;
 229 #endif
 230
 231 } // end of namespace sd
 232
 233 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */