office-gobmx/include/sfx2/DocumentMetadataAccess.hxx
Noel 1250aecd71 loplugin:stringviewparam extend to new..
O[U]StringBuffer methods

Change-Id: I0ffbc33d54ae7c98b5652434f3370ee4f819f6f4
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/110090
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2021-01-29 09:25:12 +01:00

152 lines
6 KiB
C++

/* -*- 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_SFX2_DOCUMENTMETADATAACCESS_HXX
#define INCLUDED_SFX2_DOCUMENTMETADATAACCESS_HXX
#include <sal/config.h>
#include <sfx2/dllapi.h>
#include <com/sun/star/rdf/XDocumentMetadataAccess.hpp>
#include <cppuhelper/implbase.hxx>
#include <memory>
/** Implementation of the interface com.sun.star.rdf.XDocumentMetadataAccess
This is not a service only because it needs some kind of XML ID registry
from the document, and i do not like defining an API for that.
Also, the implementation does _no_ locking, so make sure access is
protected externally.
*/
namespace com::sun::star::embed {
class XStorage;
}
namespace com::sun::star::frame {
class XModel;
}
namespace com::sun::star::uno { class XComponentContext; }
class SfxObjectShell;
namespace sfx2 {
/** create a base URI for loading metadata from an ODF (sub)document.
@param i_xContext component context
@param i_xModel model of the document (required if no URI is provided)
@param i_rPkgURI the URI for the package
@param i_rSubDocument (optional) path of the subdocument in package
@return a base URI suitable for XDocumentMetadataAccess::loadFromStorage
*/
css::uno::Reference< css::rdf::XURI> SFX2_DLLPUBLIC
createBaseURI(
css::uno::Reference<css::uno::XComponentContext> const & i_xContext,
css::uno::Reference<css::frame::XModel> const & i_xModel,
OUString const & i_rPkgURI,
std::u16string_view i_rSubDocument = std::u16string_view());
struct DocumentMetadataAccess_Impl;
class DocumentMetadataAccess final :
public cppu::WeakImplHelper<css::rdf::XDocumentMetadataAccess>
{
DocumentMetadataAccess(const DocumentMetadataAccess&) = delete;
DocumentMetadataAccess& operator=( const DocumentMetadataAccess& ) = delete;
public:
explicit DocumentMetadataAccess(css::uno::Reference< css::uno::XComponentContext > const & i_xContext,
SfxObjectShell const & i_rRegistrySupplier,
OUString const & i_rBaseURI);
// N.B.: in contrast to previous, this constructor does _not_ initialize!
// caller must immediately call loadFromStorage/Medium!
explicit DocumentMetadataAccess(css::uno::Reference< css::uno::XComponentContext > const & i_xContext,
SfxObjectShell const & i_rRegistrySupplier);
virtual ~DocumentMetadataAccess() override;
// css::rdf::XNode:
virtual OUString SAL_CALL getStringValue() override;
// css::rdf::XURI:
virtual OUString SAL_CALL getNamespace() override;
virtual OUString SAL_CALL getLocalName() override;
// css::rdf::XRepositorySupplier:
virtual css::uno::Reference<
css::rdf::XRepository > SAL_CALL getRDFRepository() override;
// css::rdf::XDocumentMetadataAccess:
virtual css::uno::Reference<
css::rdf::XMetadatable > SAL_CALL
getElementByMetadataReference(
const css::beans::StringPair & i_rReference) override;
virtual css::uno::Reference< css::rdf::XMetadatable > SAL_CALL
getElementByURI(const css::uno::Reference< css::rdf::XURI > & i_xURI) override;
virtual css::uno::Sequence< css::uno::Reference< css::rdf::XURI > > SAL_CALL getMetadataGraphsWithType(
const css::uno::Reference< css::rdf::XURI > & i_xType) override;
virtual css::uno::Reference< css::rdf::XURI> SAL_CALL
addMetadataFile(const OUString & i_rFileName,
const css::uno::Sequence< css::uno::Reference< css::rdf::XURI > > & i_rTypes) override;
virtual css::uno::Reference< css::rdf::XURI> SAL_CALL
importMetadataFile(::sal_Int16 i_Format,
const css::uno::Reference< css::io::XInputStream > & i_xInStream,
const OUString & i_rFileName,
const css::uno::Reference< css::rdf::XURI > & i_xBaseURI,
const css::uno::Sequence< css::uno::Reference< css::rdf::XURI > > & i_rTypes) override;
virtual void SAL_CALL removeMetadataFile(
const css::uno::Reference<
css::rdf::XURI > & i_xGraphName) override;
virtual void SAL_CALL addContentOrStylesFile(
const OUString & i_rFileName) override;
virtual void SAL_CALL removeContentOrStylesFile(
const OUString & i_rFileName) override;
virtual void SAL_CALL loadMetadataFromStorage(
const css::uno::Reference<
css::embed::XStorage > & i_xStorage,
const css::uno::Reference<
css::rdf::XURI > & i_xBaseURI,
const css::uno::Reference<
css::task::XInteractionHandler> & i_xHandler) override;
virtual void SAL_CALL storeMetadataToStorage(
const css::uno::Reference<
css::embed::XStorage > & i_xStorage) override;
virtual void SAL_CALL loadMetadataFromMedium(
const css::uno::Sequence<
css::beans::PropertyValue > & i_rMedium) override;
virtual void SAL_CALL storeMetadataToMedium(
const css::uno::Sequence<
css::beans::PropertyValue > & i_rMedium) override;
private:
std::unique_ptr<DocumentMetadataAccess_Impl> m_pImpl;
};
} // namespace sfx2
#endif // INCLUDED_SFX2_DOCUMENTMETADATAACCESS_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */