Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 184 insertions, 0 deletions

diff --git a/offapi/com/sun/star/resource/XStringResourceResolver.idl b/offapi/com/sun/star/resource/XStringResourceResolver.idl
new file mode 100644
index 000000000..f56605987
--- /dev/null
+++ b/offapi/com/sun/star/resource/XStringResourceResolver.idl
@@ -0,0 +1,184 @@
+/* -*- 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_XStringResourceResolver_idl__
+#define __com_sun_star_resource_XStringResourceResolver_idl__
+
+#include <com/sun/star/resource/MissingResourceException.idl>
+#include <com/sun/star/util/XModifyBroadcaster.idl>
+#include <com/sun/star/lang/Locale.idl>
+
+
+
+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();
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */