binfilter/inc/bf_svtools/imageresourceaccess.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: imageresourceaccess.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SVTOOLS_INC_IMAGERESOURCEACCESS_HXX
  32 #define SVTOOLS_INC_IMAGERESOURCEACCESS_HXX
  33
  34 #ifndef INCLUDED_SVTDLLAPI_H
  35 #include "bf_svtools/svtdllapi.h"
  36 #endif
  37
  38 /** === begin UNO includes === **/
  39 #ifndef _COM_SUN_STAR_IO_XINPUTSTREAM_HPP_
  40 #include <com/sun/star/io/XInputStream.hpp>
  41 #endif
  42 #ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
  43 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  44 #endif
  45 /** === end UNO includes === **/
  46
  47 class SvStream;
  48 //........................................................................
  49 namespace binfilter
  50 {
  51 //........................................................................
  52
  53     //====================================================================
  54     //= ImageResourceAccess
  55     //====================================================================
  56     /** helper class for obtaining streams (which also can be used with the ImageProducer)
  57         from a resource
  58     */
  59     class ImageResourceAccess
  60     {
  61     private:
  62         ImageResourceAccess();    // never implemented
  63
  64     public:
  65         /** determines whether the given URL denotes an image within a resource
  66         */
  67          static  bool        isImageResourceURL( const ::rtl::OUString& _rURL );
  68
  69         /** for a given URL of an image within a resource, this method retrieves
  70             an SvStream for this image.
  71
  72             This method works for arbitrary URLs denoting an image, since the
  73             <type scope="com::sun::star::graphics">GraphicsProvider</type> service is used
  74             to resolve the URL. However, obtaining the stream is expensive (since
  75             the image must be copied), so you are strongly encouraged to only use it
  76             when you know that the image is small enough.
  77         */
  78          static  SvStream*   getImageStream(
  79                     const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB,
  80                     const ::rtl::OUString& _rImageResourceURL
  81                 );
  82     };
  83
  84 //........................................................................
  85 }
  86 //........................................................................
  87
  88 #endif // DBA14_SVTOOLS_INC_IMAGERESOURCEACCESS_HXX
  89