diff options
Diffstat (limited to 'include/svtools/imageresourceaccess.hxx')
-rw-r--r-- | include/svtools/imageresourceaccess.hxx | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/include/svtools/imageresourceaccess.hxx b/include/svtools/imageresourceaccess.hxx new file mode 100644 index 0000000000..ca76c0909f --- /dev/null +++ b/include/svtools/imageresourceaccess.hxx @@ -0,0 +1,69 @@ +/* -*- 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 . + */ + +#pragma once + +#include <sal/config.h> + +#include <memory> +#include <string_view> + +#include <config_options.h> +#include <svtools/svtdllapi.h> + +#include <com/sun/star/uno/Reference.hxx> + +namespace com :: sun :: star :: io { class XInputStream; } +namespace com :: sun :: star :: uno { class XComponentContext; } + +class SvStream; + +namespace svt::GraphicAccess +{ + +/** Helpers for obtaining streams (which also can be used with the ImageProducer) + from a resource. +*/ + +/** determines whether the given URL denotes an image within a resource */ +UNLESS_MERGELIBS(SVT_DLLPUBLIC) bool isSupportedURL(std::u16string_view rURL); + +/** for a given URL of an image within a resource, this method retrieves an + SvStream for this image. + + This method works for arbitrary URLs denoting an image, since the + css::graphics::GraphicsProvider service is used + to resolve the URL. However, obtaining the stream is expensive (since + the image must be copied), so you are strongly encouraged to only use it + when you know that the image is small enough. +*/ +UNLESS_MERGELIBS(SVT_DLLPUBLIC) std::unique_ptr<SvStream> getImageStream( + css::uno::Reference<css::uno::XComponentContext> const & rxContext, + OUString const & rImageResourceURL); + +/** for a given URL of an image within a resource, this method retrieves + a css::io::XInputStream for this image. +*/ +UNLESS_MERGELIBS(SVT_DLLPUBLIC) css::uno::Reference<css::io::XInputStream> getImageXStream( + css::uno::Reference<css::uno::XComponentContext> const & rxContext, + OUString const & rImageResourceURL); + +} // namespace svt::GraphicAccess + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |