include/svx/gallery1.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_SVX_GALLERY1_HXX
  21 #define INCLUDED_SVX_GALLERY1_HXX
  22
  23 #include <rtl/ustring.hxx>
  24 #include <svl/SfxBroadcaster.hxx>
  25 #include <svx/svxdllapi.h>
  26 #include <tools/urlobj.hxx>
  27
  28 #include <cstdio>
  29 #include <memory>
  30 #include <vector>
  31
  32 class Gallery;
  33 class GalleryFileStorage;
  34 class GalleryFileStorageEntry;
  35 class GalleryObjectCollection;
  36 class GalleryStorageLocations;
  37 class GalleryTheme;
  38
  39 class SVXCORE_DLLPUBLIC GalleryThemeEntry
  40 {
  41 private:
  42
  43     std::unique_ptr<GalleryFileStorageEntry> mpGalleryStorageEngineEntry;
  44     OUString                aName;
  45     sal_uInt32              nId;
  46     bool                    bReadOnly;
  47     bool                    bModified;
  48     bool                    bThemeNameFromResource;
  49
  50 public:
  51                             GalleryThemeEntry( bool bCreateUniqueURL,
  52                                                const INetURLObject& rBaseURL,
  53                                                const OUString& rName,
  54                                                bool bReadOnly, bool bNewFile,
  55                                                sal_uInt32 nId, bool bThemeNameFromResource );
  56     ~GalleryThemeEntry();
  57
  58     GalleryStorageLocations& getGalleryStorageLocations() const;
  59
  60     GalleryTheme* createGalleryTheme(Gallery* pGallery);
  61
  62     std::unique_ptr<GalleryFileStorage> createGalleryStorageEngine(GalleryObjectCollection& mrGalleryObjectCollection);
  63
  64     const OUString&         GetThemeName() const { return aName; }
  65
  66     bool                    IsReadOnly() const { return bReadOnly; }
  67     bool                    IsDefault() const;
  68
  69     bool                    IsHidden() const { return aName.match("private://gallery/hidden/"); }
  70
  71     bool                    IsModified() const { return bModified; }
  72     void                    SetModified( bool bSet ) { bModified = ( bSet && !IsReadOnly() ); }
  73
  74     void                    SetName( const OUString& rNewName );
  75     bool                    IsNameFromResource() const { return bThemeNameFromResource; }
  76
  77     sal_uInt32              GetId() const { return nId; }
  78     void                    SetId( sal_uInt32 nNewId, bool bResetThemeName );
  79
  80
  81     void removeTheme();
  82
  83     std::unique_ptr<GalleryTheme> getCachedTheme(Gallery* pGallery);
  84
  85     void setStorageLocations(INetURLObject& rURL);
  86 };
  87
  88 class SfxListener;
  89 class GalleryTheme;
  90 class GalleryThemeCacheEntry;
  91
  92
  93 class SVXCORE_DLLPUBLIC Gallery final : public SfxBroadcaster
  94 {
  95     typedef std::vector<GalleryThemeCacheEntry*> GalleryCacheThemeList;
  96
  97 private:
  98
  99     std::vector< std::unique_ptr<GalleryThemeEntry> > aThemeList;
 100     GalleryCacheThemeList       aThemeCache;
 101     INetURLObject               aRelURL;
 102     INetURLObject               aUserURL;
 103     bool                        bMultiPath;
 104
 105     SAL_DLLPRIVATE void         ImplLoad( std::u16string_view rMultiPath );
 106     SAL_DLLPRIVATE void         ImplLoadSubDirs( const INetURLObject& rBaseURL, bool& rbIsReadOnly );
 107
 108     GalleryThemeEntry*          ImplGetThemeEntry( std::u16string_view rThemeName );
 109
 110     SAL_DLLPRIVATE GalleryTheme* ImplGetCachedTheme( GalleryThemeEntry* pThemeEntry );
 111     SAL_DLLPRIVATE void         ImplDeleteCachedTheme( GalleryTheme const * pTheme );
 112
 113     Gallery&                    operator=( Gallery const & ) = delete; // MSVC2015 workaround
 114                                 Gallery( Gallery const & ) = delete; // MSVC2015 workaround
 115
 116 public:
 117                                 // only for gengal utility!
 118                                 Gallery( std::u16string_view rMultiPath );
 119                                 virtual ~Gallery() override;
 120
 121     static Gallery*             GetGalleryInstance();
 122
 123     size_t                      GetThemeCount() const { return aThemeList.size(); }
 124     SAL_DLLPRIVATE const GalleryThemeEntry* GetThemeInfo( size_t nPos )
 125                                 { return nPos < aThemeList.size() ? aThemeList[ nPos ].get() : nullptr; }
 126     const GalleryThemeEntry* GetThemeInfo( std::u16string_view rThemeName ) { return ImplGetThemeEntry( rThemeName ); }
 127
 128     bool                        HasTheme( std::u16string_view rThemeName );
 129     SAL_DLLPRIVATE OUString     GetThemeName( sal_uInt32 nThemeId ) const;
 130
 131     bool                        CreateTheme( const OUString& rThemeName );
 132     void                        RenameTheme( const OUString& rOldName, const OUString& rNewName );
 133     bool                        RemoveTheme( const OUString& rThemeName );
 134
 135     SAL_RET_MAYBENULL GalleryTheme* AcquireTheme( std::u16string_view rThemeName, SfxListener& rListener );
 136     void                        ReleaseTheme( GalleryTheme* pTheme, SfxListener& rListener );
 137
 138 public:
 139
 140     SAL_DLLPRIVATE const INetURLObject& GetUserURL() const { return aUserURL; }
 141     SAL_DLLPRIVATE const INetURLObject& GetRelativeURL() const { return aRelURL; }
 142 };
 143
 144 #endif // INCLUDED_SVX_GALLERY1_HXX
 145
 146 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */