LibreOffice Module basic (master) 1
dlgcont.hxx
Go to the documentation of this file.
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
28#include <comphelper/uno3.hxx>
29
30namespace basic
31{
32
33
35{
36 // Methods to distinguish between different library types
37 virtual rtl::Reference<SfxLibrary> implCreateLibrary( const OUString& aName ) override;
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
60
61 virtual void onNewRootStorage() override;
62
63 virtual OUString getInfoFileName() const override;
64 virtual OUString getOldInfoFileName() const override;
65 virtual OUString getLibElementFileExtension() const override;
66 virtual OUString getLibrariesDir() const override;
67
68public:
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 >
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
88typedef ::cppu::ImplHelper1 < css::resource::XStringResourceSupplier
90
91class SfxDialogLibrary final : public SfxLibrary
93{
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
107public:
109 (
110 ModifiableHelper& _rModifiable,
111 OUString aName,
112 const css::uno::Reference< css::ucb::XSimpleFileAccess3 >& xSFI,
114 );
115
117 (
118 ModifiableHelper& _rModifiable,
119 OUString aName,
120 const css::uno::Reference< css::ucb::XSimpleFileAccess3 >& xSFI,
121 const OUString& aLibInfoFileURL, const OUString& aStorageURL, bool ReadOnly,
123 );
124
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 >&
137 {
139 }
140
141 static bool containsValidDialog( const css::uno::Any& aElement );
142
143private:
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: */
virtual rtl::Reference< SfxLibrary > implCreateLibraryLink(const OUString &aName, const OUString &aLibInfoFileURL, const OUString &StorageURL, bool ReadOnly) override
Definition: dlgcont.cxx:106
virtual sal_Bool SAL_CALL HasExecutableCode(const OUString &) override
Definition: dlgcont.cxx:465
virtual OUString getOldInfoFileName() const override
Definition: dlgcont.cxx:71
virtual bool isLibraryElementValid(const css::uno::Any &rElement) const override
Definition: dlgcont.cxx:121
css::uno::Reference< css::resource::XStringResourcePersistence > implCreateStringResource(class SfxDialogLibrary *pDialog)
Definition: dlgcont.cxx:371
virtual css::uno::Any importLibraryElement(const css::uno::Reference< css::container::XNameContainer > &xLibrary, const OUString &aElementName, const OUString &aFile, const css::uno::Reference< css::io::XInputStream > &xElementStream) override
Definition: dlgcont.cxx:278
virtual OUString getLibrariesDir() const override
Definition: dlgcont.cxx:81
virtual rtl::Reference< SfxLibrary > implCreateLibrary(const OUString &aName) override
Definition: dlgcont.cxx:100
virtual OUString getLibElementFileExtension() const override
Definition: dlgcont.cxx:76
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override
Definition: dlgcont.cxx:477
virtual void importFromOldStorage(const OUString &aFile) override
Definition: dlgcont.cxx:356
virtual rtl::Reference< SfxLibraryContainer > createInstanceImpl() override
Definition: dlgcont.cxx:361
virtual void SAL_CALL storeLibrariesToStorage(const css::uno::Reference< css::embed::XStorage > &RootStorage) override
Definition: dlgcont.cxx:197
virtual css::uno::Any createEmptyLibraryElement() override
Definition: dlgcont.cxx:113
virtual void onNewRootStorage() override
Definition: dlgcont.cxx:422
virtual OUString SAL_CALL getImplementationName() override
Definition: dlgcont.cxx:472
SfxDialogLibraryContainer(const css::uno::Reference< css::embed::XStorage > &xStorage)
virtual void writeLibraryElement(const css::uno::Reference< css::container::XNameContainer > &xLibrary, const OUString &aElementName, const css::uno::Reference< css::io::XOutputStream > &xOutput) override
Definition: dlgcont.cxx:160
virtual OUString getInfoFileName() const override
Definition: dlgcont.cxx:66
SfxDialogLibrary(ModifiableHelper &_rModifiable, OUString aName, const css::uno::Reference< css::ucb::XSimpleFileAccess3 > &xSFI, const OUString &aLibInfoFileURL, const OUString &aStorageURL, bool ReadOnly, SfxDialogLibraryContainer *pParent)
virtual bool isLibraryElementValid(const css::uno::Any &rElement) const override
Definition: dlgcont.cxx:590
virtual css::uno::Reference< css::resource::XStringResourceResolver > SAL_CALL getStringResource() override
Definition: dlgcont.cxx:575
css::uno::Reference< css::resource::XStringResourcePersistence > m_xStringResourcePersistence
Definition: dlgcont.hxx:95
SfxDialogLibraryContainer * m_pParent
Definition: dlgcont.hxx:94
const css::uno::Reference< css::resource::XStringResourcePersistence > & getStringResourcePersistence() const
Definition: dlgcont.hxx:136
virtual void storeResourcesAsURL(const OUString &URL, const OUString &NewName) override
Definition: dlgcont.cxx:532
virtual bool isModified() override
Definition: dlgcont.cxx:514
SfxDialogLibrary(ModifiableHelper &_rModifiable, OUString aName, const css::uno::Reference< css::ucb::XSimpleFileAccess3 > &xSFI, SfxDialogLibraryContainer *pParent)
virtual void storeResources() override
Definition: dlgcont.cxx:525
virtual void storeResourcesToURL(const OUString &URL, const css::uno::Reference< css::task::XInteractionHandler > &xHandler) override
Definition: dlgcont.cxx:549
const OUString & getName() const
Definition: dlgcont.hxx:132
static bool containsValidDialog(const css::uno::Any &aElement)
Definition: dlgcont.cxx:583
virtual void storeResourcesToStorage(const css::uno::Reference< css::embed::XStorage > &xStorage) override
Definition: dlgcont.cxx:561
OUString aName
::cppu::ImplHelper1< css::resource::XStringResourceSupplier > SfxDialogLibrary_BASE
Definition: dlgcont.hxx:89
unsigned char sal_Bool
#define DECLARE_XINTERFACE()