providerhelper.hxx

Go to the documentation of this file.

/* -*- 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_UCBHELPER_PROVIDERHELPER_HXX
#define INCLUDED_UCBHELPER_PROVIDERHELPER_HXX
 
#include <vector>
#include <memory>
#include <com/sun/star/ucb/XContentProvider.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <cppuhelper/implbase.hxx>
 
#include <rtl/ref.hxx>
#include <ucbhelper/ucbhelperdllapi.h>
 
 
namespace com::sun::star::ucb {
    class XPropertySetRegistry;
    class XPersistentPropertySet;
}
 
namespace com::sun::star::uno { class XComponentContext; }
 
namespace ucbhelper_impl { struct ContentProviderImplHelper_Impl; }
 
namespace ucbhelper {
 
 
class ContentImplHelper;
typedef rtl::Reference< ContentImplHelper > ContentImplHelperRef;
typedef std::vector< ContentImplHelperRef > ContentRefList;
 
class UCBHELPER_DLLPUBLIC ContentProviderImplHelper :
                                    public cppu::WeakImplHelper<
                                        css::lang::XServiceInfo,
                                        css::ucb::XContentProvider>
{
    friend class ContentImplHelper;
 
    std::unique_ptr<ucbhelper_impl::ContentProviderImplHelper_Impl> m_pImpl;
 
protected:
    osl::Mutex m_aMutex;
    css::uno::Reference< css::uno::XComponentContext >  m_xContext;
 
private:
    UCBHELPER_DLLPRIVATE void removeContent( ContentImplHelper* pContent );
 
    UCBHELPER_DLLPRIVATE css::uno::Reference< css::ucb::XPropertySetRegistry >
    getAdditionalPropertySetRegistry();
 
    UCBHELPER_DLLPRIVATE void cleanupRegisteredContents();
 
protected:
    rtl::Reference< ContentImplHelper >
    queryExistingContent( const css::uno::Reference< css::ucb::XContentIdentifier >& Identifier );
 
    rtl::Reference< ContentImplHelper >
    queryExistingContent( const OUString& rURL );
 
    void registerNewContent(
        const css::uno::Reference< css::ucb::XContent > & xContent );
 
public:
 
 
    // Construction/Destruction
 
 
    ContentProviderImplHelper(
                css::uno::Reference< css::uno::XComponentContext > xContext );
    virtual ~ContentProviderImplHelper() override;
 
 
    // XServiceInfo
 
 
    virtual OUString SAL_CALL
    getImplementationName() override = 0;
    virtual sal_Bool SAL_CALL
    supportsService( const OUString& ServiceName ) override;
    virtual css::uno::Sequence< OUString > SAL_CALL
    getSupportedServiceNames() override = 0;
 
 
    // XContentProvider
 
 
    virtual css::uno::Reference< css::ucb::XContent > SAL_CALL
    queryContent( const css::uno::Reference< css::ucb::XContentIdentifier >& Identifier ) override = 0;
    virtual sal_Int32 SAL_CALL
    compareContentIds( const css::uno::Reference< css::ucb::XContentIdentifier >& Id1,
                       const css::uno::Reference< css::ucb::XContentIdentifier >& Id2 ) override;
 
 
    // Non-interface methods.
 
 
    osl::Mutex& getContentListMutex() { return m_aMutex; }
 
    void queryExistingContents( ContentRefList& rContents );
 
    css::uno::Reference< css::ucb::XPersistentPropertySet >
    getAdditionalPropertySet( const OUString& rKey, bool bCreate );
 
    bool renameAdditionalPropertySet( const OUString& rOldKey,
                                          const OUString& rNewKey,
                                          bool bRecursive );
 
    bool copyAdditionalPropertySet( const OUString& rSourceKey,
                                        const OUString& rTargetKey,
                                        bool bRecursive );
 
    bool removeAdditionalPropertySet( const OUString& rKey,
                                          bool bRecursive );
};
 
} // namespace ucbhelper
 
#endif /* ! INCLUDED_UCBHELPER_PROVIDERHELPER_HXX */
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */