1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_resource_StringResourceWithLocation_idl__
29#define __com_sun_star_resource_StringResourceWithLocation_idl__
30
31#ifndef __com_sun_star_resource_XStringResourceWithLocation_idl__
32#include <com/sun/star/resource/XStringResourceWithLocation.idl>
33#endif
34
35
36//=============================================================================
37
38module com { module sun { module star { module resource {
39
40//=============================================================================
41
42/** specifies a service providing access to a resource string table implementing the
43    <type scope="com::sun::star::resource">XStringResourceWithLocation</type> interface.
44 */
45published service StringResourceWithLocation : com::sun::star::resource::XStringResourceWithLocation
46{
47    /** is used to initialize the object on its creation.
48
49        @param URL
50            Specifies the location used to load and store - if
51            the ReadOnly state allows it - the string table data.
52
53        @param ReadOnly
54            Specifies if the resource should be read only,
55            see <code>XStringResourceManager::isReadOnly</code>
56
57        @param locale
58            Specifies if the locale first to be used as current locale. Internally
59            the <code>XStringResourceManager::setCurrentLocale</code> method is
60            called with FindClosestMatch=true.
61            see <code>XStringResourceManager::setCurrentLocale</code>
62
63        @param BaseName
64            Base string for the file names used to store the locale data.
65            The locale data is stored in Java properties files also following
66            the corresponding naming sceme. The files will be named like this:
67            "[BaseName]_[Language]_[Country].properties",
68            e.g. "MyBaseName_en_US.properties"
69            If an empty string is passed for BaseName, "strings" will be used
70            as BaseName.
71
72        @param Comment
73            Comment stored first in each properties file followed by a line
74            feed character. The line feed character is added automatically
75            and hasn't to be part of the comment string. The caller is re-
76            sponsible that the passed string is a valid comment in a Java
77            properties file, e.g. "# My strings". The string may be empty.
78
79        @param Handler
80            a <type scope="com::sun::star::task">XInteractionHandler</type>
81            to be passed to ucb. This may be a null interface.
82
83        @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
84            if no string or an empty string is passed as URL
85     */
86    create( [in] string URL, [in] boolean ReadOnly,
87            [in] com::sun::star::lang::Locale locale,
88            [in] string BaseName, [in] string Comment,
89            [in] com::sun::star::task::XInteractionHandler Handler )
90        raises( ::com::sun::star::lang::IllegalArgumentException );
91};
92
93//=============================================================================
94
95}; }; }; };
96
97#endif
98