LibreOffice LibreOffice 7.2 SDK API Reference

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#ifndef __com_sun_star_resource_XStringResourceManager_idl__
20#define __com_sun_star_resource_XStringResourceManager_idl__
21
22#include <com/sun/star/resource/MissingResourceException.idl>
23#include <com/sun/star/resource/XStringResourceResolver.idl>
24#include <com/sun/star/container/ElementExistException.idl>
25#include <com/sun/star/lang/Locale.idl>
26#include <com/sun/star/lang/IllegalArgumentException.idl>
27#include <com/sun/star/lang/NoSupportException.idl>
28
29
30
31module com { module sun { module star { module resource {
32
47 interface XStringResourceManager: com::sun::star::resource::XStringResourceResolver
48{
54 boolean isReadOnly();
55
56
76 void setCurrentLocale
77 (
78 [in] com::sun::star::lang::Locale Locale,
79 [in] boolean FindClosestMatch
80 )
81 raises( com::sun::star::lang::IllegalArgumentException );
82
83
95 void setDefaultLocale( [in] com::sun::star::lang::Locale Locale )
96 raises( com::sun::star::lang::IllegalArgumentException,
97 com::sun::star::lang::NoSupportException );
98
99
115 void setString
116 (
117 [in] string ResourceID,
118 [in] string Str
119 )
120 raises( com::sun::star::lang::NoSupportException );
121
122
147 void setStringForLocale
148 (
149 [in] string ResourceID,
150 [in] string Str,
151 [in] com::sun::star::lang::Locale locale
152 )
153 raises( com::sun::star::lang::NoSupportException );
154
155
171 void removeId( [in] string ResourceID )
172 raises( com::sun::star::resource::MissingResourceException,
173 com::sun::star::lang::NoSupportException );
174
175
196 void removeIdForLocale( [in] string ResourceID, [in] com::sun::star::lang::Locale locale )
197 raises( com::sun::star::resource::MissingResourceException,
198 com::sun::star::lang::NoSupportException );
199
200
222 void newLocale( [in] com::sun::star::lang::Locale locale )
223 raises( com::sun::star::container::ElementExistException,
224 com::sun::star::lang::IllegalArgumentException,
225 com::sun::star::lang::NoSupportException );
226
227
240 void removeLocale( [in] com::sun::star::lang::Locale locale )
241 raises( com::sun::star::lang::IllegalArgumentException,
242 com::sun::star::lang::NoSupportException );
243
244
282 long getUniqueNumericId()
283 raises( com::sun::star::lang::NoSupportException );
284};
285
286
287}; }; }; };
288
289#endif
290
291/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
ElementExistException.idl
IllegalArgumentException.idl
Locale.idl
MissingResourceException.idl
NoSupportException.idl
XStringResourceResolver.idl
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:39
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
com::sun::star::lang::NoSupportException
This exception is thrown when a feature of an interface is not supported.
Definition: NoSupportException.idl:39
com::sun::star::resource::MissingResourceException
is used to signal that a resource is missing.
Definition: MissingResourceException.idl:34
com::sun::star::resource::XStringResourceManager
Interface to manage a resource string table containing a set of strings for different locales.
Definition: XStringResourceManager.idl:48
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:46
com
Definition: Accessible.idl:22
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:48