summaryrefslogtreecommitdiffstats
path: root/include/svx/gallery1.hxx
blob: 8de817484bd2da1be7d53c01a94112877f129030 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_SVX_GALLERY1_HXX
#define INCLUDED_SVX_GALLERY1_HXX

#include <rtl/ustring.hxx>
#include <svl/SfxBroadcaster.hxx>
#include <svx/svxdllapi.h>
#include <tools/urlobj.hxx>
#include <svx/gallerybinaryengineentry.hxx>
#include <svx/gallerybinaryengine.hxx>

#include <cstdio>
#include <memory>
#include <vector>

class GalleryBinaryEngineEntry;
class GalleryStorageLocations;
class GalleryTheme;

class GalleryThemeEntry
{
private:

    std::unique_ptr<GalleryBinaryEngineEntry>     mpGalleryStorageEngineEntry;
    OUString                aName;
    sal_uInt32              nId;
    bool                    bReadOnly;
    bool                    bModified;
    bool                    bThemeNameFromResource;

public:
                            GalleryThemeEntry( bool bCreateUniqueURL,
                                               const INetURLObject& rBaseURL,
                                               const OUString& rName,
                                               bool bReadOnly, bool bNewFile,
                                               sal_uInt32 nId, bool bThemeNameFromResource );

    const std::unique_ptr<GalleryBinaryEngineEntry>& getGalleryStorageEngineEntry() const { return mpGalleryStorageEngineEntry; }

    GalleryStorageLocations& getGalleryStorageLocations() const { return *mpGalleryStorageEngineEntry->getGalleryStorageLocations(); }

    GalleryTheme* createGalleryTheme(Gallery* pGallery);

    std::unique_ptr<GalleryBinaryEngine> createGalleryStorageEngine(GalleryObjectCollection& mrGalleryObjectCollection);

    const OUString&         GetThemeName() const { return aName; }

    bool                    IsReadOnly() const { return bReadOnly; }
    bool                    IsDefault() const;

    bool                    IsHidden() const { return aName.match("private://gallery/hidden/"); }

    bool                    IsModified() const { return bModified; }
    void                    SetModified( bool bSet ) { bModified = ( bSet && !IsReadOnly() ); }

    void                    SetName( const OUString& rNewName );
    bool                    IsNameFromResource() const { return bThemeNameFromResource; }

    sal_uInt32              GetId() const { return nId; }
    void                    SetId( sal_uInt32 nNewId, bool bResetThemeName );


    void removeTheme();

    std::unique_ptr<GalleryTheme> getCachedTheme(Gallery* pGallery);

    void setStorageLocations(INetURLObject& rURL);
};

class SfxListener;
class GalleryTheme;
class GalleryThemeCacheEntry;


class SVXCORE_DLLPUBLIC Gallery final : public SfxBroadcaster
{
    typedef std::vector<GalleryThemeCacheEntry*> GalleryCacheThemeList;

private:

    std::vector< std::unique_ptr<GalleryThemeEntry> > aThemeList;
    GalleryCacheThemeList       aThemeCache;
    INetURLObject               aRelURL;
    INetURLObject               aUserURL;
    bool                        bMultiPath;

    SAL_DLLPRIVATE void         ImplLoad( const OUString& rMultiPath );
    SAL_DLLPRIVATE void         ImplLoadSubDirs( const INetURLObject& rBaseURL, bool& rbIsReadOnly );

    GalleryThemeEntry*          ImplGetThemeEntry( std::u16string_view rThemeName );

    SAL_DLLPRIVATE GalleryTheme* ImplGetCachedTheme( GalleryThemeEntry* pThemeEntry );
    SAL_DLLPRIVATE void         ImplDeleteCachedTheme( GalleryTheme const * pTheme );

    Gallery&                    operator=( Gallery const & ) = delete; // MSVC2015 workaround
                                Gallery( Gallery const & ) = delete; // MSVC2015 workaround

public:
                                // only for gengal utility!
                                Gallery( const OUString& rMultiPath );
                                virtual ~Gallery() override;

    static Gallery*             GetGalleryInstance();

    size_t                      GetThemeCount() const { return aThemeList.size(); }
    SAL_DLLPRIVATE const GalleryThemeEntry* GetThemeInfo( size_t nPos )
                                { return nPos < aThemeList.size() ? aThemeList[ nPos ].get() : nullptr; }
    const GalleryThemeEntry* GetThemeInfo( std::u16string_view rThemeName ) { return ImplGetThemeEntry( rThemeName ); }

    bool                        HasTheme( std::u16string_view rThemeName );
    SAL_DLLPRIVATE OUString     GetThemeName( sal_uInt32 nThemeId ) const;

    bool                        CreateTheme( const OUString& rThemeName );
    void                        RenameTheme( const OUString& rOldName, const OUString& rNewName );
    bool                        RemoveTheme( const OUString& rThemeName );

    GalleryTheme*               AcquireTheme( std::u16string_view rThemeName, SfxListener& rListener );
    void                        ReleaseTheme( GalleryTheme* pTheme, SfxListener& rListener );

public:

    SAL_DLLPRIVATE const INetURLObject& GetUserURL() const { return aUserURL; }
    SAL_DLLPRIVATE const INetURLObject& GetRelativeURL() const { return aRelURL; }
};

#endif // INCLUDED_SVX_GALLERY1_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */