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
  28
  29 namespace ucbhelper
  30 {
  31
  32 struct ContentIdentifier_Impl;
  33
  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 com::sun::star::lang::XTypeProvider,
  45                   public com::sun::star::ucb::XContentIdentifier
  46 {
  47 public:
  48     ContentIdentifier( const OUString& rURL );
  49     virtual ~ContentIdentifier();
  50
  51     // XInterface
  52     virtual com::sun::star::uno::Any SAL_CALL
  53     queryInterface( const com::sun::star::uno::Type & rType )
  54         throw( com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  55     virtual void SAL_CALL
  56     acquire() throw() SAL_OVERRIDE;
  57     virtual void SAL_CALL
  58     release() throw() SAL_OVERRIDE;
  59
  60     // XTypeProvider
  61     virtual com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL
  62     getImplementationId()
  63         throw( com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  64     virtual com::sun::star::uno::Sequence< com::sun::star::uno::Type > SAL_CALL
  65     getTypes()
  66         throw( com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  67
  68     // XContentIdentifier
  69     virtual OUString SAL_CALL
  70     getContentIdentifier()
  71         throw( com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  72     virtual OUString SAL_CALL
  73     getContentProviderScheme()
  74         throw( com::sun::star::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
  75
  76 private:
  77     ContentIdentifier_Impl* m_pImpl;
  78 };
  79
  80 } /* namespace ucbhelper */
  81
  82 #endif /* ! INCLUDED_UCBHELPER_CONTENTIDENTIFIER_HXX */
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */