offapi/com/sun/star/resource/XStringResourceSupplier.idl

   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: XStringResourceSupplier.idl,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 __com_sun_star_resource_XStringResourceSupplier_idl__
  32 #define __com_sun_star_resource_XStringResourceSupplier_idl__
  33
  34 #ifndef __com_sun_star_resource_XStringResourceResolver_idl__
  35 #include <com/sun/star/resource/XStringResourceResolver.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module resource {
  42
  43 //=============================================================================
  44
  45 /**
  46     Provides access to a string resource represented by a
  47     <type scope="com::sun::star::resource">XStringResourceResolver</type>.
  48  */
  49 interface XStringResourceSupplier: com::sun::star::uno::XInterface
  50 {
  51     //-------------------------------------------------------------------------
  52
  53     /**
  54         Provides access to a string resource.
  55         Depending on the context the returned object may also support
  56         <type scope="com::sun::star::resource">XStringResourceManager</type> or
  57         <type scope="com::sun::star::resource">XStringResourcePersistence</type> or
  58         <type scope="com::sun::star::resource">XStringResourceWithStorage</type>
  59
  60         @returns an interface
  61         <type scope="com::sun::star::resource">XStringResourceResolver</type>
  62      */
  63     com::sun::star::resource::XStringResourceResolver getStringResource();
  64 };
  65
  66 //=============================================================================
  67
  68 }; }; }; };
  69
  70 /*=============================================================================
  71
  72 =============================================================================*/
  73 #endif