summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/resource
diff options
context:
space:
mode:
authorMichael Stahl <mstahl@redhat.com>2013-04-27 21:58:51 +0200
committerMichael Stahl <mstahl@redhat.com>2013-06-04 12:01:00 +0200
commit9f12a9da8d91364d4d0865021adbe62bfa09148c (patch)
treea74d3d9213f950fff68bca5ba07662e15b82d217 /offapi/com/sun/star/resource
parent*api: convert <type>Foo</type> (diff)
downloadcore-9f12a9da8d91364d4d0865021adbe62bfa09148c.tar.gz
core-9f12a9da8d91364d4d0865021adbe62bfa09148c.zip
*api: convert <type scope="bar">Foo</type>
This looks much better now. sed -i 's,<type scope="\([^"]*\)">\([^<]\+\)</type>,\1::\2,g' Change-Id: I94cd0f93afa89855b62dadeb229d2b2e1775cd80
Diffstat (limited to 'offapi/com/sun/star/resource')
-rw-r--r--offapi/com/sun/star/resource/StringResource.idl2
-rw-r--r--offapi/com/sun/star/resource/StringResourceWithLocation.idl6
-rw-r--r--offapi/com/sun/star/resource/StringResourceWithStorage.idl4
-rw-r--r--offapi/com/sun/star/resource/XLocale.idl4
-rw-r--r--offapi/com/sun/star/resource/XResourceBundle.idl2
-rw-r--r--offapi/com/sun/star/resource/XStringResourceManager.idl34
-rw-r--r--offapi/com/sun/star/resource/XStringResourcePersistence.idl18
-rw-r--r--offapi/com/sun/star/resource/XStringResourceResolver.idl10
-rw-r--r--offapi/com/sun/star/resource/XStringResourceSupplier.idl10
-rw-r--r--offapi/com/sun/star/resource/XStringResourceWithLocation.idl2
-rw-r--r--offapi/com/sun/star/resource/XStringResourceWithStorage.idl6
11 files changed, 49 insertions, 49 deletions
diff --git a/offapi/com/sun/star/resource/StringResource.idl b/offapi/com/sun/star/resource/StringResource.idl
index f4c56e38b8e4..f60cf1a3ce3a 100644
--- a/offapi/com/sun/star/resource/StringResource.idl
+++ b/offapi/com/sun/star/resource/StringResource.idl
@@ -28,7 +28,7 @@ module com { module sun { module star { module resource {
/** specifies a service providing access to a resource string table implementing the
- <type scope="com::sun::star::awt">XDialog</type> interface.
+ com::sun::star::awt::XDialog interface.
*/
service StringResource : com::sun::star::resource::XStringResourcePersistence;
diff --git a/offapi/com/sun/star/resource/StringResourceWithLocation.idl b/offapi/com/sun/star/resource/StringResourceWithLocation.idl
index c47f73e3498d..a3eced0d45d4 100644
--- a/offapi/com/sun/star/resource/StringResourceWithLocation.idl
+++ b/offapi/com/sun/star/resource/StringResourceWithLocation.idl
@@ -28,7 +28,7 @@ module com { module sun { module star { module resource {
/** specifies a service providing access to a resource string table implementing the
- <type scope="com::sun::star::resource">XStringResourceWithLocation</type> interface.
+ com::sun::star::resource::XStringResourceWithLocation interface.
*/
service StringResourceWithLocation : com::sun::star::resource::XStringResourceWithLocation
{
@@ -65,10 +65,10 @@ service StringResourceWithLocation : com::sun::star::resource::XStringResourceWi
properties file, e.g. "# My strings". The string may be empty.
@param Handler
- a <type scope="com::sun::star::task">XInteractionHandler</type>
+ a com::sun::star::task::XInteractionHandler
to be passed to ucb. This may be a null interface.
- @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
+ @throws com::sun::star::lang::IllegalArgumentException
if no string or an empty string is passed as URL
*/
create( [in] string URL, [in] boolean ReadOnly,
diff --git a/offapi/com/sun/star/resource/StringResourceWithStorage.idl b/offapi/com/sun/star/resource/StringResourceWithStorage.idl
index d3aa828a9eaf..e99a70409388 100644
--- a/offapi/com/sun/star/resource/StringResourceWithStorage.idl
+++ b/offapi/com/sun/star/resource/StringResourceWithStorage.idl
@@ -28,7 +28,7 @@ module com { module sun { module star { module resource {
/** specifies a service providing access to a resource string table implementing the
- <type scope="com::sun::star::resource">XStringResourceWithStorage</type> interface.
+ com::sun::star::resource::XStringResourceWithStorage interface.
*/
service StringResourceWithStorage : com::sun::star::resource::XStringResourceWithStorage
{
@@ -64,7 +64,7 @@ service StringResourceWithStorage : com::sun::star::resource::XStringResourceWit
responsible 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>
+ @throws com::sun::star::lang::IllegalArgumentException
if a null interface is passed as Storage
*/
create( [in] ::com::sun::star::embed::XStorage Storage,
diff --git a/offapi/com/sun/star/resource/XLocale.idl b/offapi/com/sun/star/resource/XLocale.idl
index 80be59373e6f..799c616b295b 100644
--- a/offapi/com/sun/star/resource/XLocale.idl
+++ b/offapi/com/sun/star/resource/XLocale.idl
@@ -29,7 +29,7 @@
module com { module sun { module star { module resource {
-/** offers some operations on <type scope="com::sun::star::lang">Locale</type>
+/** offers some operations on com::sun::star::lang::Locale
structures.@see XResourceBundle
@see Locale
*/
@@ -181,7 +181,7 @@ published interface XLocale: com::sun::star::uno::XInterface
[in] com::sun::star::lang::Locale inLocale );
/** @returns
- <TRUE/> if the <type scope="com::sun::star::lang">Locale</type> <var>l1</var> is equal to the
+ <TRUE/> if the com::sun::star::lang::Locale <var>l1</var> is equal to the
other one.
<p>A locale is deemed equal to another locale with identical
diff --git a/offapi/com/sun/star/resource/XResourceBundle.idl b/offapi/com/sun/star/resource/XResourceBundle.idl
index fa50b6d1ecfa..beb8ef911be1 100644
--- a/offapi/com/sun/star/resource/XResourceBundle.idl
+++ b/offapi/com/sun/star/resource/XResourceBundle.idl
@@ -160,7 +160,7 @@ module com { module sun { module star { module resource {
<p>The get methods all require the key as an argument and return
the object if found. If the object is not found, the get methods
- throw a <type scope="com::sun::star::container">NoSuchElementException</type>.
+ throw a com::sun::star::container::NoSuchElementException.
<P> <STRONG>NOTE:</STRONG> You should always supply a base service
with no suffixes. This will be the class of "last resort" if a
diff --git a/offapi/com/sun/star/resource/XStringResourceManager.idl b/offapi/com/sun/star/resource/XStringResourceManager.idl
index ad9a8f39062f..f4fccf7c2c94 100644
--- a/offapi/com/sun/star/resource/XStringResourceManager.idl
+++ b/offapi/com/sun/star/resource/XStringResourceManager.idl
@@ -35,7 +35,7 @@ module com { module sun { module star { module resource {
strings for different locales.
The interface is derived from
- <type scope="com::sun::star::resource">XStringResourceResolver</type>
+ com::sun::star::resource::XStringResourceResolver
that allows to access the string table but not to modify it. This
interface also allows to modify the string table.
@@ -66,11 +66,11 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol
the default locale will be used <TRUE/>.
<p>If false: If the exact locale that should be set is not available
- a <type scope="com::sun::star::lang">IllegalArgumentException</type>
+ a com::sun::star::lang::IllegalArgumentException
is thrown.
<p>If false: If the exact locale that should be set is not available
- a <type scope="com::sun::star::lang">IllegalArgumentException</type>
+ a com::sun::star::lang::IllegalArgumentException
is thrown.
*/
void setCurrentLocale
@@ -86,10 +86,10 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol
@param aLocale
Specifies the default locale to be used.
If this locale is not available a
- <type scope="com::sun::star::lang">IllegalArgumentException</type>
+ com::sun::star::lang::IllegalArgumentException
is thrown.
- @throws <type scope="com::sun::star::lang">NoSupportException</type>
+ @throws com::sun::star::lang::NoSupportException
if the resource is read only, see <member>isReadOnly</member>
*/
void setDefaultLocale( [in] com::sun::star::lang::Locale locale )
@@ -109,7 +109,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol
@param Str
String to be associated with the Resource ID.
- @throws <type scope="com::sun::star::lang">NoSupportException</type>
+ @throws com::sun::star::lang::NoSupportException
if the resource is read only, see <member>isReadOnly</member>
*/
void setString
@@ -141,7 +141,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol
The locale has to match exactly with one of the locales provided by
<member>getLocales</member>. A closest match search is not supported.
- @throws <type scope="com::sun::star::lang">NoSupportException</type>
+ @throws com::sun::star::lang::NoSupportException
if the resource is read only, see <member>isReadOnly</member>
*/
void setStringForLocale
@@ -161,11 +161,11 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol
The Resource ID to be removed for the current locale.
@throws
- <type scope="com::sun::star::resource">MissingResourceException</type>
+ com::sun::star::resource::MissingResourceException
if the Resource ID is not valid.
@throws
- <type scope="com::sun::star::lang">NoSupportException</type>
+ com::sun::star::lang::NoSupportException
if the resource is read only, see <member>isReadOnly</member>
*/
void removeId( [in] string ResourceID )
@@ -186,11 +186,11 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol
<member>getLocales</member>. A closest match search is not supported.
@throws
- <type scope="com::sun::star::resource">MissingResourceException</type>
+ com::sun::star::resource::MissingResourceException
if the Resource ID is not valid.
@throws
- <type scope="com::sun::star::lang">NoSupportException</type>
+ com::sun::star::lang::NoSupportException
if the resource is read only, see <member>isReadOnly</member>
*/
void removeIdForLocale( [in] string ResourceID, [in] com::sun::star::lang::Locale locale )
@@ -208,15 +208,15 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol
will be copied from the default locale.</p>
@throws
- <type scope="com::sun::star::container">ElementExistException</type>
+ com::sun::star::container::ElementExistException
if the Locale already has been created.
@throws
- <type scope="com::sun::star::lang">IllegalArgumentException</type>
+ com::sun::star::lang::IllegalArgumentException
if the Locale is not valid.
@throws
- <type scope="com::sun::star::lang">NoSupportException</type>
+ com::sun::star::lang::NoSupportException
if the resource is read only, see <member>isReadOnly</member>
*/
void newLocale( [in] com::sun::star::lang::Locale locale )
@@ -230,11 +230,11 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol
strings for each locale.
@throws
- <type scope="com::sun::star::lang">IllegalArgumentException</type>
+ com::sun::star::lang::IllegalArgumentException
if the Locale to be removed is not supported.
@throws
- <type scope="com::sun::star::lang">NoSupportException</type>
+ com::sun::star::lang::NoSupportException
if the resource is read only, see <member>isReadOnly</member>
*/
void removeLocale( [in] com::sun::star::lang::Locale locale )
@@ -273,7 +273,7 @@ interface XStringResourceManager: com::sun::star::resource::XStringResourceResol
that may not have been loaded so far.
@throws
- <type scope="com::sun::star::lang">NoSupportException</type>
+ com::sun::star::lang::NoSupportException
if the next available id exceeds the range of type long.
So it's not recommended to use own Resource IDs starting
with a decimal number near to the maximum long value if
diff --git a/offapi/com/sun/star/resource/XStringResourcePersistence.idl b/offapi/com/sun/star/resource/XStringResourcePersistence.idl
index 386efaeddb2c..d5af600f1e46 100644
--- a/offapi/com/sun/star/resource/XStringResourcePersistence.idl
+++ b/offapi/com/sun/star/resource/XStringResourcePersistence.idl
@@ -51,7 +51,7 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM
see StringResourceWithLocation.
The StringResourceWithStorage is initialized with an instance
- of <type scope="com::sun::star::embed">XStorage</type>
+ of com::sun::star::embed::XStorage
used to load data from and store data to,
see StringResourceWithStorage.
@@ -59,15 +59,15 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM
this method does nothing.
This method can throw all exceptions thrown by the methods of
- <type scope="com::sun::star::embed">XStorage</type> respectively
+ com::sun::star::embed::XStorage respectively
a <type scope="com::sun::star::ucb">CommandAbortedException in
case of a StringResourceWithLocation for all exceptions that are
not handled by a previously specified
- <type scope="com::sun::star::task">XInteractionHandler</type>.
+ com::sun::star::task::XInteractionHandler.
The handler to be used for the store operation can be specified
during initialization of StringResourceWithLocation.
- @throws <type scope="com::sun::star::lang">NoSupportException</type>
+ @throws com::sun::star::lang::NoSupportException
if no URL or no valid storage are provided.
*/
void store()
@@ -116,7 +116,7 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM
This method can be used to make a copy of the current string
table data to a storage. This method can throw all exceptions
- thrown by the methods of <type scope="com::sun::star::embed">XStorage</type>
+ thrown by the methods of com::sun::star::embed::XStorage
@param Storage
all string table data will be stored to this storage.
@@ -135,7 +135,7 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM
for a detailed description see <member>setComment</member>.
This method can throw all exceptions thrown by the methods of
- <type scope="com::sun::star::embed">XStorage</type>
+ com::sun::star::embed::XStorage
*/
void storeToStorage( [in] ::com::sun::star::embed::XStorage Storage,
[in] string BaseName, [in] string Comment )
@@ -172,7 +172,7 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM
for a detailed description see <member>setComment</member>.
@param Handler
- a <type scope="com::sun::star::task">XInteractionHandler</type>.
+ a com::sun::star::task::XInteractionHandler.
It will be passed to ucb handle exceptions. Exceptions not processed
by this handler will be passed as com::sun::star::uno::Exception. If
this parameter is null this applies to all exceptions thrown by ucb.
@@ -189,7 +189,7 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM
in a binary format.
This method is intended to support datatransfer functionality, e.g. provided
- by <type scope="com::sun::star::datatransfer">XTransferable</type> and
+ by com::sun::star::datatransfer::XTransferable and
related interfaces.
See <member>importBinary</member>).
@@ -208,7 +208,7 @@ interface XStringResourcePersistence: com::sun::star::resource::XStringResourceM
only contains the locales and strings specified in the binary data.
This method is intended to support datatransfer functionality, e.g. provided
- by <type scope="com::sun::star::datatransfer">XTransferable</type> and
+ by com::sun::star::datatransfer::XTransferable and
related interfaces.
See <member>importBinary</member>).
diff --git a/offapi/com/sun/star/resource/XStringResourceResolver.idl b/offapi/com/sun/star/resource/XStringResourceResolver.idl
index d236f0d69ddf..899d1f215dc0 100644
--- a/offapi/com/sun/star/resource/XStringResourceResolver.idl
+++ b/offapi/com/sun/star/resource/XStringResourceResolver.idl
@@ -31,13 +31,13 @@ module com { module sun { module star { module resource {
Interface to access strings in a resource.
The interface is derived from
- <type scope="com::sun::star::util">XModifyBroadcaster</type>
+ com::sun::star::util::XModifyBroadcaster
- All registered <type scope="com::sun::star::util">XModifyListener</type>
+ 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
- <type scope="com::sun::star::resource">XStringResourceManager</type>
+ 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.
@@ -48,7 +48,7 @@ interface XStringResourceResolver: com::sun::star::util::XModifyBroadcaster
Resolves the passed ResoureID for the current locale. This
locale is set during initialization of the object implementing
this interface or - in case that also the interface
- <type scope="com::sun::star::resource">XStringResourceManager</type>
+ com::sun::star::resource::XStringResourceManager
is supported - by using the <code>XStringResourceManager::setLocale</code>
method.
@@ -84,7 +84,7 @@ interface XStringResourceResolver: com::sun::star::util::XModifyBroadcaster
@return the localized string for the specified ID and Locale
- @throws <type scope="com::sun::star::resource">MissingResourceException</type>
+ @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 )
diff --git a/offapi/com/sun/star/resource/XStringResourceSupplier.idl b/offapi/com/sun/star/resource/XStringResourceSupplier.idl
index ff897b3277c1..5889dee83caf 100644
--- a/offapi/com/sun/star/resource/XStringResourceSupplier.idl
+++ b/offapi/com/sun/star/resource/XStringResourceSupplier.idl
@@ -29,7 +29,7 @@ module com { module sun { module star { module resource {
/**
Provides access to a string resource represented by a
- <type scope="com::sun::star::resource">XStringResourceResolver</type>.
+ com::sun::star::resource::XStringResourceResolver.
*/
interface XStringResourceSupplier: com::sun::star::uno::XInterface
{
@@ -37,12 +37,12 @@ interface XStringResourceSupplier: com::sun::star::uno::XInterface
/**
Provides access to a string resource.
Depending on the context the returned object may also support
- <type scope="com::sun::star::resource">XStringResourceManager</type> or
- <type scope="com::sun::star::resource">XStringResourcePersistence</type> or
- <type scope="com::sun::star::resource">XStringResourceWithStorage</type>
+ com::sun::star::resource::XStringResourceManager or
+ com::sun::star::resource::XStringResourcePersistence or
+ com::sun::star::resource::XStringResourceWithStorage
@returns an interface
- <type scope="com::sun::star::resource">XStringResourceResolver</type>
+ com::sun::star::resource::XStringResourceResolver
*/
com::sun::star::resource::XStringResourceResolver getStringResource();
};
diff --git a/offapi/com/sun/star/resource/XStringResourceWithLocation.idl b/offapi/com/sun/star/resource/XStringResourceWithLocation.idl
index c2f4d3e585c0..bc2d60bc3977 100644
--- a/offapi/com/sun/star/resource/XStringResourceWithLocation.idl
+++ b/offapi/com/sun/star/resource/XStringResourceWithLocation.idl
@@ -63,7 +63,7 @@ interface XStringResourceWithLocation: com::sun::star::resource::XStringResource
and afterwards this location is in sync with the resource data.
</p>
- @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
+ @throws com::sun::star::lang::IllegalArgumentException
if an empty string is passed as URL
*/
void setURL( [in] string URL )
diff --git a/offapi/com/sun/star/resource/XStringResourceWithStorage.idl b/offapi/com/sun/star/resource/XStringResourceWithStorage.idl
index 9529dc71f621..205e17b9afba 100644
--- a/offapi/com/sun/star/resource/XStringResourceWithStorage.idl
+++ b/offapi/com/sun/star/resource/XStringResourceWithStorage.idl
@@ -27,7 +27,7 @@ module com { module sun { module star { module resource {
/**
Extends XStringResourcePersistence by methods to handle an
- associated <type scope="com::sun::star::embed">XStorage</type> instance.
+ associated com::sun::star::embed::XStorage instance.
@see XStringResourcePersistence.
*/
@@ -39,7 +39,7 @@ interface XStringResourceWithStorage: com::sun::star::resource::XStringResourceP
this storage. The modified state will be unmodified after the call.
This method can throw all exceptions thrown by the methods of
- <type scope="com::sun::star::embed">XStorage</type>
+ com::sun::star::embed::XStorage
*/
void storeAsStorage( [in] ::com::sun::star::embed::XStorage Storage )
raises( com::sun::star::uno::Exception );
@@ -63,7 +63,7 @@ interface XStringResourceWithStorage: com::sun::star::resource::XStringResourceP
this storage is in sync with the resource data.
</p>
- @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
+ @throws com::sun::star::lang::IllegalArgumentException
if a null interface is passed as Storage
*/
void setStorage( [in] ::com::sun::star::embed::XStorage Storage )