basic/source/inc/dlgcont.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 "namecont.hxx"
  23
  24 #include <com/sun/star/resource/XStringResourceSupplier.hpp>
  25 #include <com/sun/star/resource/XStringResourcePersistence.hpp>
  26
  27 #include <cppuhelper/implbase1.hxx>
  28 #include <comphelper/uno3.hxx>
  29
  30 namespace basic
  31 {
  32
  33
  34 class SfxDialogLibraryContainer final : public SfxLibraryContainer
  35 {
  36     // Methods to distinguish between different library types
  37     virtual rtl::Reference<SfxLibrary> implCreateLibrary( const OUString& aName ) override;
  38     virtual rtl::Reference<SfxLibrary> implCreateLibraryLink
  39         ( const OUString& aName, const OUString& aLibInfoFileURL,
  40           const OUString& StorageURL, bool ReadOnly ) override;
  41     virtual css::uno::Any createEmptyLibraryElement() override;
  42     virtual bool isLibraryElementValid(const css::uno::Any& rElement) const override;
  43     virtual void writeLibraryElement
  44     (
  45         const css::uno::Reference< css::container::XNameContainer>& xLibrary,
  46         const OUString& aElementName,
  47         const css::uno::Reference< css::io::XOutputStream >& xOutput
  48     ) override;
  49
  50     virtual css::uno::Any importLibraryElement
  51     (
  52         const css::uno::Reference< css::container::XNameContainer>& xLibrary,
  53         const OUString& aElementName,
  54         const OUString& aFile,
  55         const css::uno::Reference< css::io::XInputStream >& xElementStream ) override;
  56
  57     virtual void importFromOldStorage( const OUString& aFile ) override;
  58
  59     virtual rtl::Reference<SfxLibraryContainer> createInstanceImpl() override;
  60
  61     virtual void onNewRootStorage() override;
  62
  63     virtual const char*    getInfoFileName() const override;
  64     virtual const char*    getOldInfoFileName() const override;
  65     virtual const char*    getLibElementFileExtension() const override;
  66     virtual const char*    getLibrariesDir() const override;
  67
  68 public:
  69     SfxDialogLibraryContainer();
  70     SfxDialogLibraryContainer( const css::uno::Reference< css::embed::XStorage >& xStorage );
  71
  72     // Methods XStorageBasedLibraryContainer
  73     virtual void SAL_CALL storeLibrariesToStorage(
  74         const css::uno::Reference< css::embed::XStorage >& RootStorage ) override;
  75
  76     // Resource handling
  77     css::uno::Reference< css::resource::XStringResourcePersistence >
  78         implCreateStringResource( class SfxDialogLibrary* pDialog );
  79
  80     // Methods XServiceInfo
  81     virtual OUString SAL_CALL getImplementationName( ) override;
  82     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames( ) override;
  83     // XLibraryQueryExecutable
  84     virtual sal_Bool SAL_CALL HasExecutableCode(const OUString&) override;
  85 };
  86
  87
  88 typedef ::cppu::ImplHelper1 <   css::resource::XStringResourceSupplier
  89                             >   SfxDialogLibrary_BASE;
  90
  91 class SfxDialogLibrary final : public SfxLibrary
  92                         ,public SfxDialogLibrary_BASE
  93 {
  94     SfxDialogLibraryContainer*                                        m_pParent;
  95     css::uno::Reference< css::resource::XStringResourcePersistence>   m_xStringResourcePersistence;
  96     OUString                                                          m_aName;
  97
  98     // Provide modify state including resources
  99     virtual bool isModified() override;
 100     virtual void storeResources() override;
 101     virtual void storeResourcesAsURL( const OUString& URL, const OUString& NewName ) override;
 102     virtual void storeResourcesToURL( const OUString& URL,
 103         const css::uno::Reference< css::task::XInteractionHandler >& xHandler  ) override;
 104     virtual void storeResourcesToStorage( const css::uno::Reference
 105         < css::embed::XStorage >& xStorage ) override;
 106
 107 public:
 108     SfxDialogLibrary
 109     (
 110         ModifiableHelper& _rModifiable,
 111         const OUString& aName,
 112         const css::uno::Reference< css::ucb::XSimpleFileAccess3 >& xSFI,
 113         SfxDialogLibraryContainer* pParent
 114     );
 115
 116     SfxDialogLibrary
 117     (
 118         ModifiableHelper& _rModifiable,
 119         const OUString& aName,
 120         const css::uno::Reference< css::ucb::XSimpleFileAccess3 >& xSFI,
 121         const OUString& aLibInfoFileURL, const OUString& aStorageURL, bool ReadOnly,
 122         SfxDialogLibraryContainer* pParent
 123     );
 124
 125     DECLARE_XINTERFACE()
 126     DECLARE_XTYPEPROVIDER()
 127
 128     // XStringResourceSupplier
 129     virtual css::uno::Reference< css::resource::XStringResourceResolver >
 130         SAL_CALL getStringResource(  ) override;
 131
 132     const OUString& getName() const
 133         { return m_aName; }
 134
 135     const css::uno::Reference< css::resource::XStringResourcePersistence >&
 136         getStringResourcePersistence() const
 137     {
 138         return m_xStringResourcePersistence;
 139     }
 140
 141     static bool containsValidDialog( const css::uno::Any& aElement );
 142
 143 private:
 144     virtual bool isLibraryElementValid(const css::uno::Any& rElement) const override;
 145 };
 146
 147 }   // namespace basic
 148
 149 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */