include/svtools/imageresourceaccess.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_SVTOOLS_IMAGERESOURCEACCESS_HXX
  21 #define INCLUDED_SVTOOLS_IMAGERESOURCEACCESS_HXX
  22
  23 #include <svtools/svtdllapi.h>
  24
  25 #include <com/sun/star/uno/Reference.hxx>
  26
  27 namespace com :: sun :: star :: io { class XInputStream; }
  28 namespace com :: sun :: star :: uno { class XComponentContext; }
  29
  30 class SvStream;
  31
  32 namespace svt
  33 {
  34 namespace GraphicAccess
  35 {
  36
  37 /** Helpers for obtaining streams (which also can be used with the ImageProducer)
  38     from a resource.
  39 */
  40
  41 /** determines whether the given URL denotes an image within a resource */
  42 SVT_DLLPUBLIC bool isSupportedURL(OUString const & rURL);
  43
  44 /** for a given URL of an image within a resource, this method retrieves an
  45     SvStream for this image.
  46
  47     This method works for arbitrary URLs denoting an image, since the
  48     css::graphics::GraphicsProvider service is used
  49     to resolve the URL. However, obtaining the stream is expensive (since
  50     the image must be copied), so you are strongly encouraged to only use it
  51     when you know that the image is small enough.
  52 */
  53 SVT_DLLPUBLIC SvStream* getImageStream(
  54             css::uno::Reference<css::uno::XComponentContext> const & rxContext,
  55             OUString const & rImageResourceURL);
  56
  57 /** for a given URL of an image within a resource, this method retrieves
  58     an css::io::XInputStream for this image.
  59 */
  60 SVT_DLLPUBLIC css::uno::Reference<css::io::XInputStream> getImageXStream(
  61             css::uno::Reference<css::uno::XComponentContext> const & rxContext,
  62             OUString const & rImageResourceURL);
  63
  64 } // namespace GraphicAccess
  65 } // namespace svt
  66
  67 #endif // INCLUDED_SVTOOLS_IMAGERESOURCEACCESS_HXX
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */