Files
loongoffice/offapi/com/sun/star/resource/XStringResourceResolver.idl
Stephan Bergmann 5687eba49f Drop obsolete preprocessor directives from UNOIDL files
...which were used by ildc, which is gone since
a8485d558fab53291e2530fd9a1be581c1628deb "[API CHANGE] Remove deprecated idlc
and regmerge from the SDK", and have always been ignored as legacy by its
unoidl-write replacement.

This change has been carried out (making use of GNU sed extensions) with

> for i in $(git ls-files \*.idl); do sed -i -z -E -e 's/\n\n((#[^\n]*\n)+\n)*(#[^\n]*\n)+\n?/\n\n/g' -e 's/\n(#[^\n]*\n)+/\n/g' "$i"; done && git checkout extensions/source/activex/so_activex.idl odk/examples/OLE/activex/so_activex.idl

which apparently happened to do the work.  (The final two files are not UNOIDL
source files.)

Change-Id: Ic9369e05d46e8f7e8a304ab01740b171b92335cd
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/135683
Tested-by: Jenkins
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2022-06-13 16:27:45 +02:00

177 lines
6.1 KiB
Plaintext

/* -*- 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 .
*/
module com { module sun { module star { module resource {
/**
Interface to access strings in a resource.
The interface is derived from
com::sun::star::util::XModifyBroadcaster
All registered com::sun::star::util::XModifyListener
interfaces will be notified if either the current locale changes or if
a string is added, changed or removed. This usually will only happen if
the implementing object also supports the interface
com::sun::star::resource::XStringResourceManager
and is used in the design mode of a Dialog or String table editor.
But also changing the locale at runtime can be supported in this way.
*/
interface XStringResourceResolver: com::sun::star::util::XModifyBroadcaster
{
/**
Resolves the passed ResourceID for the current locale. This
locale is set during initialization of the object implementing
this interface or - in case that also the interface
com::sun::star::resource::XStringResourceManager
is supported - by using the <code>XStringResourceManager::setLocale</code>
method.
@param ResourceID
ID to specify the string inside the resource.
The ID can - but not needs to - be a hierarchical
name like "foo.nothing.invalid".
@return the localized string for the specified ID
@throws ::com::sun::star::resource::MissingResourceException
if no entry exists for the given ResourceID
*/
string resolveString( [in] string ResourceID )
raises( com::sun::star::resource::MissingResourceException );
/** Resolves the passed ResourceID for a specific locale.
It's not recommended to use this method to get the best
performance as the implementation may be optimized for
the use of the current locale.
@param ResourceID
ID to specify the string inside the resource.
The ID can - but not needs to - be a hierarchical
name like "foo.nothing.invalid".
@param locale
The locale the string should be resolved for.
The locale has to match exactly with one of the locales provided by
getLocales(). A closest match search is not supported.
@return the localized string for the specified ID and Locale
@throws com::sun::star::resource::MissingResourceException
if no entry exists for the given ResourceID or locale
*/
string resolveStringForLocale( [in] string ResourceID, [in] com::sun::star::lang::Locale locale )
raises( com::sun::star::resource::MissingResourceException );
/**
Checks if the resource contains an entry for the given ResourceID
and current locale.
@param ResourceID
ID to specify the string inside the resource.
@return `TRUE` if an entry exists, otherwise `FALSE`
*/
boolean hasEntryForId( [in] string ResourceID );
/**
Checks if the resource contains an entry for the given ResourceID and locale.
It's not recommended to use this method to get the best
performance as the implementation may be optimized for
the use of the current locale.
@param ResourceID
ID to specify the string inside the resource.
@param locale
The locale the entry should be checked for.
The locale has to match exactly with one of the locales provided by
getLocales(). A closest match search is not supported.
@return `TRUE` if an entry exists, otherwise `FALSE`
*/
boolean hasEntryForIdAndLocale( [in] string ResourceID, [in] com::sun::star::lang::Locale locale );
/**
Returns a sequence of all valid Resource IDs for the current locale
@return a sequence of all valid Resource IDs
*/
sequence<string> getResourceIDs();
/**
Returns a sequence of all valid Resource IDs for a specific locale
It's not recommended to use this method to get the best
performance as the implementation may be optimized for
the use of the current locale.
@param locale
The locale the ResourceIDs should be returned for.
The locale has to match exactly with one of the locales provided by
getLocales(). A closest match search is not supported.
@return a sequence of all valid Resource IDs
*/
sequence<string> getResourceIDsForLocale( [in] com::sun::star::lang::Locale locale );
/** Returns the current locale specified in the accessed resource.
If no locale is available, the returned Locale structure
only contains empty strings.
@returns the used locale
*/
com::sun::star::lang::Locale getCurrentLocale();
/** Returns the default locale of the accessed resource. In many
cases this will be the locale of the Office initially used
to create the resource.
@return the used locale
*/
com::sun::star::lang::Locale getDefaultLocale();
/**
Returns a sequence of all supported locales
@return a sequence of all supported locales
*/
sequence<com::sun::star::lang::Locale> getLocales();
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */