include/ucbhelper/contentidentifier.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 #ifndef INCLUDED_UCBHELPER_CONTENTIDENTIFIER_HXX
  21 #define INCLUDED_UCBHELPER_CONTENTIDENTIFIER_HXX
  22
  23 #include <cppuhelper/weak.hxx>
  24 #include <com/sun/star/lang/XTypeProvider.hpp>
  25 #include <com/sun/star/ucb/XContentIdentifier.hpp>
  26 #include <ucbhelper/ucbhelperdllapi.h>
  27 #include <memory>
  28
  29
  30 namespace ucbhelper
  31 {
  32
  33 struct ContentIdentifier_Impl;
  34
  35
  36 /**
  37   * This class implements a simple identifier object for UCB contents.
  38   * It mainly stores and returns the URL as it was passed to the constructor -
  39   * The only difference is that the URL scheme will be lower cased. This can
  40   * be done, because URL schemes are never case sensitive.
  41   */
  42 class UCBHELPER_DLLPUBLIC ContentIdentifier :
  43                 public cppu::OWeakObject,
  44                 public css::lang::XTypeProvider,
  45                 public css::ucb::XContentIdentifier
  46 {
  47 public:
  48     ContentIdentifier( const OUString& rURL );
  49     virtual ~ContentIdentifier() override;
  50
  51     // XInterface
  52     virtual css::uno::Any SAL_CALL
  53     queryInterface( const css::uno::Type & rType ) override;
  54     virtual void SAL_CALL
  55     acquire() throw() override;
  56     virtual void SAL_CALL
  57     release() throw() override;
  58
  59     // XTypeProvider
  60     virtual css::uno::Sequence< sal_Int8 > SAL_CALL
  61     getImplementationId() override;
  62     virtual css::uno::Sequence< css::uno::Type > SAL_CALL
  63     getTypes() override;
  64
  65     // XContentIdentifier
  66     virtual OUString SAL_CALL
  67     getContentIdentifier() override;
  68     virtual OUString SAL_CALL
  69     getContentProviderScheme() override;
  70
  71 private:
  72     std::unique_ptr<ContentIdentifier_Impl> m_pImpl;
  73 };
  74
  75 } /* namespace ucbhelper */
  76
  77 #endif /* ! INCLUDED_UCBHELPER_CONTENTIDENTIFIER_HXX */
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */