svtools/inc/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.5 $
  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 #include "svtools/svtdllapi.h"
  35
  36 /** === begin UNO includes === **/
  37 #include <com/sun/star/io/XInputStream.hpp>
  38 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  39 /** === end UNO includes === **/
  40
  41 class SvStream;
  42 //........................................................................
  43 namespace svt
  44 {
  45 //........................................................................
  46
  47     //====================================================================
  48     //= GraphicAccess
  49     //====================================================================
  50     /** helper class for obtaining streams (which also can be used with the ImageProducer)
  51         from a resource
  52     */
  53     class GraphicAccess
  54     {
  55     private:
  56         GraphicAccess();    // never implemented
  57
  58     public:
  59         /** determines whether the given URL denotes an image within a resource
  60          ( or an image specified by a vnd.sun.star.GraphicObject scheme URL )
  61         */
  62         SVT_DLLPUBLIC static  bool        isSupportedURL( const ::rtl::OUString& _rURL );
  63
  64         /** 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
  65             an SvStream for this image.
  66
  67             This method works for arbitrary URLs denoting an image, since the
  68             <type scope="com::sun::star::graphics">GraphicsProvider</type> service is used
  69             to resolve the URL. However, obtaining the stream is expensive (since
  70             the image must be copied), so you are strongly encouraged to only use it
  71             when you know that the image is small enough.
  72         */
  73         SVT_DLLPUBLIC static  SvStream*   getImageStream(
  74                     const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB,
  75                     const ::rtl::OUString& _rImageResourceURL
  76                 );
  77
  78         /** 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
  79             an <type scope="com::sun::star::io">XInputStream</type> for this image.
  80         */
  81         SVT_DLLPUBLIC static  ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >
  82                 getImageXStream(
  83                     const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB,
  84                     const ::rtl::OUString& _rImageResourceURL
  85                 );
  86     };
  87
  88 //........................................................................
  89 } // namespace svt
  90 //........................................................................
  91
  92 #endif // DBA14_SVTOOLS_INC_IMAGERESOURCEACCESS_HXX
  93