INTEGRATION: CWS ab31 (1.1.2); FILE ADDED

2006/12/07 07:42:43 ab 1.1.2.3: #i71410# Changes in naming and comments
2006/11/24 07:27:41 ab 1.1.2.2: #i71410# Design changes
2006/11/10 12:43:10 ab 1.1.2.1: #i71410# Service specification for String Resource component

1 files changed, 100 insertions, 0 deletions

diff --git a/offapi/com/sun/star/resource/StringResourceWithStorage.idl b/offapi/com/sun/star/resource/StringResourceWithStorage.idl
new file mode 100644
index 000000000000..3fd05bfb9f61
--- /dev/null
+++ b/offapi/com/sun/star/resource/StringResourceWithStorage.idl
@@ -0,0 +1,100 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: StringResourceWithStorage.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: hr $ $Date: 2007-01-02 15:43:18 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *    Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_resource_StringResourceWithStorage_idl__
+#define __com_sun_star_resource_StringResourceWithStorage_idl__
+
+#ifndef __com_sun_star_resource_XStringResourceWithStorage_idl__
+#include <com/sun/star/resource/XStringResourceWithStorage.idl>
+#endif
+
+
+//=============================================================================
+
+module com { module sun { module star { module awt {
+
+//=============================================================================
+
+/** specifies a service providing access to a resource string table implementing the
+    <type scope="com::sun::star::resource">XStringResourceWithStorage</type> interface.
+ */
+service StringResourceWithStorage : com::sun::star::resource::XStringResourceWithStorage
+{
+    /** is used to initialize the object on its creation.
+
+        @param Storage
+            Specifies the storage used to load and store - if
+            the ReadOnly state allows it - the string table data.
+
+        @param ReadOnly
+            Specifies if the resource should be read only,
+            see <code>XStringResourceManager::isReadOnly</code>
+
+        @param locale
+            Specifies if the locale first to be used as current locale. Internally
+            the <code>XStringResourceManager::setCurrentLocale</code> method is
+            called with FindClosestMatch=true.
+            see <code>XStringResourceManager::setCurrentLocale</code>
+
+        @param BaseName
+            Base string for the file names used to store the locale data.
+            The locale data is stored in Java properties files also following
+            the corresponding naming sceme. The files will be named like this:
+            "[BaseName]_[Language]_[Country].properties",
+            e.g. "MyBaseName_en_US.properties"
+            If an empty string is passed for BaseName, "strings" will be used
+            as BaseName.
+
+        @param Comment
+            Comment stored first in each properties file followed by a line
+            feed character. The line feed character is added automatically
+            and hasn't to be part of the comment string. The caller is re-
+            sponsible that the passed string is a valid comment in a Java
+            properties file, e.g. "# My strings". The string may be empty.
+
+        @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
+            if a null interface is passed as Storage
+     */
+    create( [in] ::com::sun::star::embed::XStorage Storage,
+            [in] boolean ReadOnly, [in] com::sun::star::lang::Locale locale,
+            [in] string BaseName, [in] string Comment )
+        raises( ::com::sun::star::lang::IllegalArgumentException );
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif