diff options
Diffstat (limited to 'svtools/inc/imageresourceaccess.hxx')
-rw-r--r-- | svtools/inc/imageresourceaccess.hxx | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/svtools/inc/imageresourceaccess.hxx b/svtools/inc/imageresourceaccess.hxx new file mode 100644 index 000000000000..d77b1c97a512 --- /dev/null +++ b/svtools/inc/imageresourceaccess.hxx @@ -0,0 +1,90 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 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 + |