1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_resource_StringResourceWithLocation_idl__
25#define __com_sun_star_resource_StringResourceWithLocation_idl__
26
27#ifndef __com_sun_star_resource_XStringResourceWithLocation_idl__
28#include <com/sun/star/resource/XStringResourceWithLocation.idl>
29#endif
30
31
32//=============================================================================
33
34module com { module sun { module star { module resource {
35
36//=============================================================================
37
38/** specifies a service providing access to a resource string table implementing the
39    <type scope="com::sun::star::resource">XStringResourceWithLocation</type> interface.
40 */
41published service StringResourceWithLocation : com::sun::star::resource::XStringResourceWithLocation
42{
43    /** is used to initialize the object on its creation.
44
45        @param URL
46            Specifies the location used to load and store - if
47            the ReadOnly state allows it - the string table data.
48
49        @param ReadOnly
50            Specifies if the resource should be read only,
51            see <code>XStringResourceManager::isReadOnly</code>
52
53        @param locale
54            Specifies if the locale first to be used as current locale. Internally
55            the <code>XStringResourceManager::setCurrentLocale</code> method is
56            called with FindClosestMatch=true.
57            see <code>XStringResourceManager::setCurrentLocale</code>
58
59        @param BaseName
60            Base string for the file names used to store the locale data.
61            The locale data is stored in Java properties files also following
62            the corresponding naming sceme. The files will be named like this:
63            "[BaseName]_[Language]_[Country].properties",
64            e.g. "MyBaseName_en_US.properties"
65            If an empty string is passed for BaseName, "strings" will be used
66            as BaseName.
67
68        @param Comment
69            Comment stored first in each properties file followed by a line
70            feed character. The line feed character is added automatically
71            and hasn't to be part of the comment string. The caller is re-
72            sponsible that the passed string is a valid comment in a Java
73            properties file, e.g. "# My strings". The string may be empty.
74
75        @param Handler
76            a <type scope="com::sun::star::task">XInteractionHandler</type>
77            to be passed to ucb. This may be a null interface.
78
79        @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
80            if no string or an empty string is passed as URL
81     */
82    create( [in] string URL, [in] boolean ReadOnly,
83            [in] com::sun::star::lang::Locale locale,
84            [in] string BaseName, [in] string Comment,
85            [in] com::sun::star::task::XInteractionHandler Handler )
86        raises( ::com::sun::star::lang::IllegalArgumentException );
87};
88
89//=============================================================================
90
91}; }; }; };
92
93#endif
94