blob: a3eced0d45d4b313323d6e12e1910a0b9685f2f1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_resource_StringResourceWithLocation_idl__
#define __com_sun_star_resource_StringResourceWithLocation_idl__
#include <com/sun/star/resource/XStringResourceWithLocation.idl>
module com { module sun { module star { module resource {
/** specifies a service providing access to a resource string table implementing the
com::sun::star::resource::XStringResourceWithLocation interface.
*/
service StringResourceWithLocation : com::sun::star::resource::XStringResourceWithLocation
{
/** is used to initialize the object on its creation.
@param URL
Specifies the location used to load and store - if
the ReadOnly state allows it - the string table data.
@param ReadOnly
Specifies if the resource should be read only,
see <code>XStringResourceManager::isReadOnly</code>
@param locale
Specifies if the locale first to be used as current locale. Internally
the <code>XStringResourceManager::setCurrentLocale</code> method is
called with FindClosestMatch=true.
see <code>XStringResourceManager::setCurrentLocale</code>
@param BaseName
Base string for the file names used to store the locale data.
The locale data is stored in Java properties files also following
the corresponding naming scheme. The files will be named like this:
"[BaseName]_[Language]_[Country].properties",
e.g. "MyBaseName_en_US.properties"
If an empty string is passed for BaseName, "strings" will be used
as BaseName.
@param Comment
Comment stored first in each properties file followed by a line
feed character. The line feed character is added automatically
and hasn't to be part of the comment string. The caller is
responsible that the passed string is a valid comment in a Java
properties file, e.g. "# My strings". The string may be empty.
@param Handler
a com::sun::star::task::XInteractionHandler
to be passed to ucb. This may be a null interface.
@throws com::sun::star::lang::IllegalArgumentException
if no string or an empty string is passed as URL
*/
create( [in] string URL, [in] boolean ReadOnly,
[in] com::sun::star::lang::Locale locale,
[in] string BaseName, [in] string Comment,
[in] com::sun::star::task::XInteractionHandler Handler )
raises( ::com::sun::star::lang::IllegalArgumentException );
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
