LibreOffice LibreOffice 24.2 SDK API Reference

Loading...
Searching...
No Matches
XStringResourceManager.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
38 interface XStringResourceManager: com::sun::star::resource::XStringResourceResolver
39{
45 boolean isReadOnly();
46
47
67 void setCurrentLocale
68 (
69 [in] com::sun::star::lang::Locale Locale,
70 [in] boolean FindClosestMatch
71 )
72 raises( com::sun::star::lang::IllegalArgumentException );
73
74
86 void setDefaultLocale( [in] com::sun::star::lang::Locale Locale )
87 raises( com::sun::star::lang::IllegalArgumentException,
88 com::sun::star::lang::NoSupportException );
89
90
106 void setString
107 (
108 [in] string ResourceID,
109 [in] string Str
110 )
111 raises( com::sun::star::lang::NoSupportException );
112
113
138 void setStringForLocale
139 (
140 [in] string ResourceID,
141 [in] string Str,
142 [in] com::sun::star::lang::Locale locale
143 )
144 raises( com::sun::star::lang::NoSupportException );
145
146
162 void removeId( [in] string ResourceID )
163 raises( com::sun::star::resource::MissingResourceException,
164 com::sun::star::lang::NoSupportException );
165
166
187 void removeIdForLocale( [in] string ResourceID, [in] com::sun::star::lang::Locale locale )
188 raises( com::sun::star::resource::MissingResourceException,
189 com::sun::star::lang::NoSupportException );
190
191
213 void newLocale( [in] com::sun::star::lang::Locale locale )
214 raises( com::sun::star::container::ElementExistException,
215 com::sun::star::lang::IllegalArgumentException,
216 com::sun::star::lang::NoSupportException );
217
218
231 void removeLocale( [in] com::sun::star::lang::Locale locale )
232 raises( com::sun::star::lang::IllegalArgumentException,
233 com::sun::star::lang::NoSupportException );
234
235
273 long getUniqueNumericId()
274 raises( com::sun::star::lang::NoSupportException );
275};
276
277
278}; }; }; };
279
280/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::ElementExistException
is thrown by container methods, if an element is added which is already a child of the container.
Definition ElementExistException.idl:35
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition IllegalArgumentException.idl:27
com::sun::star::lang::NoSupportException
This exception is thrown when a feature of an interface is not supported.
Definition NoSupportException.idl:35
com::sun::star::resource::MissingResourceException
is used to signal that a resource is missing.
Definition MissingResourceException.idl:30
com::sun::star::resource::XStringResourceManager
Interface to manage a resource string table containing a set of strings for different locales.
Definition XStringResourceManager.idl:39
com::sun::star::resource::XStringResourceManager::setCurrentLocale
void setCurrentLocale([in] com::sun::star::lang::Locale Locale, [in] boolean FindClosestMatch)
Sets the locale to be used.
com::sun::star::resource::XStringResourceManager::removeLocale
void removeLocale([in] com::sun::star::lang::Locale locale)
Removes a locale completely including the corresponding strings for each locale.
com::sun::star::resource::XStringResourceManager::setDefaultLocale
void setDefaultLocale([in] com::sun::star::lang::Locale Locale)
Sets the default locale to be used.
com::sun::star::resource::XStringResourceManager::setStringForLocale
void setStringForLocale([in] string ResourceID, [in] string Str, [in] com::sun::star::lang::Locale locale)
Associates a String to a Resource ID for a specific locale.
com::sun::star::resource::XStringResourceManager::removeIdForLocale
void removeIdForLocale([in] string ResourceID, [in] com::sun::star::lang::Locale locale)
Removes a Resource ID including the corresponding string for s specific locale.
com::sun::star::resource::XStringResourceManager::getUniqueNumericId
long getUniqueNumericId()
Provides a numeric id that is unique within all Resource IDs used in the string table.
com::sun::star::resource::XStringResourceManager::setString
void setString([in] string ResourceID, [in] string Str)
Associates a String to a Resource ID for the current locale.
com::sun::star::resource::XStringResourceManager::newLocale
void newLocale([in] com::sun::star::lang::Locale locale)
Creates a new locale.
com::sun::star::resource::XStringResourceManager::removeId
void removeId([in] string ResourceID)
Removes a Resource ID including the corresponding string for the current locale.
com::sun::star::resource::XStringResourceManager::isReadOnly
boolean isReadOnly()
Returns the resource's read only state.
com::sun::star::resource::XStringResourceResolver
Interface to access strings in a resource.
Definition XStringResourceResolver.idl:40
com
Definition Ambiguous.idl:20
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition Locale.idl:34