LibreOffice LibreOffice 25.8 SDK API Reference

XStringResourceResolver.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21
22module com { module sun { module star { module resource {
23
39 interface XStringResourceResolver: com::sun::star::util::XModifyBroadcaster
40{
59 string resolveString( [in] string ResourceID )
60 raises( com::sun::star::resource::MissingResourceException );
61
62
84 string resolveStringForLocale( [in] string ResourceID, [in] com::sun::star::lang::Locale locale )
85 raises( com::sun::star::resource::MissingResourceException );
86
87
98 boolean hasEntryForId( [in] string ResourceID );
99
100
118 boolean hasEntryForIdAndLocale( [in] string ResourceID, [in] com::sun::star::lang::Locale locale );
119
120
126 sequence<string> getResourceIDs();
127
128
143 sequence<string> getResourceIDsForLocale( [in] com::sun::star::lang::Locale locale );
144
145
153 com::sun::star::lang::Locale getCurrentLocale();
154
155
162 com::sun::star::lang::Locale getDefaultLocale();
163
164
170 sequence<com::sun::star::lang::Locale> getLocales();
171};
172
173
174}; }; }; };
175
176/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::resource::MissingResourceException
is used to signal that a resource is missing.
Definition: MissingResourceException.idl:30
com::sun::star::resource::XStringResourceResolver
Interface to access strings in a resource.
Definition: XStringResourceResolver.idl:40
com::sun::star::resource::XStringResourceResolver::hasEntryForId
boolean hasEntryForId([in] string ResourceID)
Checks if the resource contains an entry for the given ResourceID and current locale.
com::sun::star::resource::XStringResourceResolver::getLocales
sequence< com::sun::star::lang::Locale > getLocales()
Returns a sequence of all supported locales.
com::sun::star::resource::XStringResourceResolver::getResourceIDsForLocale
sequence< string > getResourceIDsForLocale([in] com::sun::star::lang::Locale locale)
Returns a sequence of all valid Resource IDs for a specific locale.
com::sun::star::resource::XStringResourceResolver::resolveString
string resolveString([in] string ResourceID)
Resolves the passed ResourceID for the current locale.
com::sun::star::resource::XStringResourceResolver::getResourceIDs
sequence< string > getResourceIDs()
Returns a sequence of all valid Resource IDs for the current locale.
com::sun::star::resource::XStringResourceResolver::getDefaultLocale
com::sun::star::lang::Locale getDefaultLocale()
Returns the default locale of the accessed resource.
com::sun::star::resource::XStringResourceResolver::hasEntryForIdAndLocale
boolean hasEntryForIdAndLocale([in] string ResourceID, [in] com::sun::star::lang::Locale locale)
Checks if the resource contains an entry for the given ResourceID and locale.
com::sun::star::resource::XStringResourceResolver::resolveStringForLocale
string resolveStringForLocale([in] string ResourceID, [in] com::sun::star::lang::Locale locale)
Resolves the passed ResourceID for a specific locale.
com::sun::star::resource::XStringResourceResolver::getCurrentLocale
com::sun::star::lang::Locale getCurrentLocale()
Returns the current locale specified in the accessed resource.
com::sun::star::util::XModifyBroadcaster
broadcasts each modification made on the date data of the object which supports this interface.
Definition: XModifyBroadcaster.idl:32
com
Definition: Ambiguous.idl:20
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:34