offapi/com/sun/star/resource/StringResourceWithLocation.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: StringResourceWithLocation.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_StringResourceWithLocation_idl__
  32 #define __com_sun_star_resource_StringResourceWithLocation_idl__
  33
  34 #ifndef __com_sun_star_resource_XStringResourceWithLocation_idl__
  35 #include <com/sun/star/resource/XStringResourceWithLocation.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41 module com { module sun { module star { module resource {
  42
  43 //=============================================================================
  44
  45 /** specifies a service providing access to a resource string table implementing the
  46     <type scope="com::sun::star::resource">XStringResourceWithLocation</type> interface.
  47  */
  48 service StringResourceWithLocation : com::sun::star::resource::XStringResourceWithLocation
  49 {
  50     /** is used to initialize the object on its creation.
  51
  52         @param URL
  53             Specifies the location used to load and store - if
  54             the ReadOnly state allows it - the string table data.
  55
  56         @param ReadOnly
  57             Specifies if the resource should be read only,
  58             see <code>XStringResourceManager::isReadOnly</code>
  59
  60         @param locale
  61             Specifies if the locale first to be used as current locale. Internally
  62             the <code>XStringResourceManager::setCurrentLocale</code> method is
  63             called with FindClosestMatch=true.
  64             see <code>XStringResourceManager::setCurrentLocale</code>
  65
  66         @param BaseName
  67             Base string for the file names used to store the locale data.
  68             The locale data is stored in Java properties files also following
  69             the corresponding naming sceme. The files will be named like this:
  70             "[BaseName]_[Language]_[Country].properties",
  71             e.g. "MyBaseName_en_US.properties"
  72             If an empty string is passed for BaseName, "strings" will be used
  73             as BaseName.
  74
  75         @param Comment
  76             Comment stored first in each properties file followed by a line
  77             feed character. The line feed character is added automatically
  78             and hasn't to be part of the comment string. The caller is re-
  79             sponsible that the passed string is a valid comment in a Java
  80             properties file, e.g. "# My strings". The string may be empty.
  81
  82         @param Handler
  83             a <type scope="com::sun::star::task">XInteractionHandler</type>
  84             to be passed to ucb. This may be a null interface.
  85
  86         @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
  87             if no string or an empty string is passed as URL
  88      */
  89     create( [in] string URL, [in] boolean ReadOnly,
  90             [in] com::sun::star::lang::Locale locale,
  91             [in] string BaseName, [in] string Comment,
  92             [in] com::sun::star::task::XInteractionHandler Handler )
  93         raises( ::com::sun::star::lang::IllegalArgumentException );
  94 };
  95
  96 //=============================================================================
  97
  98 }; }; }; };
  99
 100 #endif