blob: 6516ef515e70d6b90e6a1dab69c7388763a11cd2 [file] [log] [blame]
/**************************************************************
*
* 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
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef SVTOOLS_INC_IMAGERESOURCEACCESS_HXX
#define SVTOOLS_INC_IMAGERESOURCEACCESS_HXX
#include "svtools/svtdllapi.h"
/** === begin UNO includes === **/
#include <com/sun/star/io/XInputStream.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
/** === end UNO includes === **/
class SvStream;
//........................................................................
namespace svt
{
//........................................................................
//====================================================================
//= GraphicAccess
//====================================================================
/** helper class for obtaining streams (which also can be used with the ImageProducer)
from a resource
*/
class GraphicAccess
{
private:
GraphicAccess(); // never implemented
public:
/** determines whether the given URL denotes an image within a resource
( or an image specified by a vnd.sun.star.GraphicObject scheme URL )
*/
SVT_DLLPUBLIC static bool isSupportedURL( const ::rtl::OUString& _rURL );
/** for a given URL of an image within a resource ( or an image specified by a vnd.sun.star.GraphicObject scheme URL ), this method retrieves
an SvStream for this image.
This method works for arbitrary URLs denoting an image, since the
<type scope="com::sun::star::graphics">GraphicsProvider</type> 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.
*/
SVT_DLLPUBLIC static SvStream* getImageStream(
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB,
const ::rtl::OUString& _rImageResourceURL
);
/** for a given URL of an image within a resource ( or an image specified by a vnd.sun.star.GraphicObject scheme URL ), this method retrieves
an <type scope="com::sun::star::io">XInputStream</type> for this image.
*/
SVT_DLLPUBLIC static ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >
getImageXStream(
const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB,
const ::rtl::OUString& _rImageResourceURL
);
};
//........................................................................
} // namespace svt
//........................................................................
#endif // DBA14_SVTOOLS_INC_IMAGERESOURCEACCESS_HXX