<html> <head> <title>Interface XStringResourceManager</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XStringResourceManager-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">resource</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XStringResourceManager</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XStringResourceManager</strong> ┗ <a href="XStringResourceResolver.html">XStringResourceResolver</a> ┗ ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XModifyBroadcaster.html">XModifyBroadcaster</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XStringResourceResolver.html">XStringResourceResolver</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>Interface to access strings in a resource. The interface is derived from ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XModifyBroadcaster.html">XModifyBroadcaster</a> All registered ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XModifyListener.html">XModifyListener</a> 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 <a href="XStringResourceManager.html">XStringResourceManager</a> 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. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Interface to manage a resource string table containing a set of strings for different locales. The interface is derived from <a href="XStringResourceResolver.html">XStringResourceResolver</a> that allows to access the string table but not to modify it. This interface also allows to modify the string table. It's designed to be used in the context of creating a string table, e.g. from a string table editor or from a Dialog Editor designing localized dialogs. </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#isReadOnly">isReadOnly</a></td> <td class="imsum_right">Returns the resource's read only state </td> </tr> <tr> <td class="imsum_left"><a href="#setCurrentLocale">setCurrentLocale</a></td> <td class="imsum_right">Sets the locale to be used </td> </tr> <tr> <td class="imsum_left"><a href="#setDefaultLocale">setDefaultLocale</a></td> <td class="imsum_right">Sets the default locale to be used </td> </tr> <tr> <td class="imsum_left"><a href="#setString">setString</a></td> <td class="imsum_right">Associates a String to a Resource ID for the current locale. If an entry for the Resource ID already exists, the string associated with it will be overwritten, otherwise a new entry will be created. </td> </tr> <tr> <td class="imsum_left"><a href="#setStringForLocale">setStringForLocale</a></td> <td class="imsum_right">Associates a String to a Resource ID for a specific locale. If an entry for the Resource ID already exists, the string associated with it will be overwritten, otherwise a new entry will be created. 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. </td> </tr> <tr> <td class="imsum_left"><a href="#removeId">removeId</a></td> <td class="imsum_right">Removes a Resource ID including the corresponding string for the current locale. </td> </tr> <tr> <td class="imsum_left"><a href="#removeIdForLocale">removeIdForLocale</a></td> <td class="imsum_right">Removes a Resource ID including the corresponding string for s specific locale. </td> </tr> <tr> <td class="imsum_left"><a href="#newLocale">newLocale</a></td> <td class="imsum_right">Creates a new locale. </td> </tr> <tr> <td class="imsum_left"><a href="#removeLocale">removeLocale</a></td> <td class="imsum_right">Removes a locale completely including the corresponding strings for each locale. </td> </tr> <tr> <td class="imsum_left"><a href="#getUniqueNumericId">getUniqueNumericId</a></td> <td class="imsum_right">Provides a numeric id that is unique within all Resource IDs used in the string table. This method takes into account all Resource IDs starting with a decimal number and only evaluates the ID until the first non digit character is reached. This allows to extend unique IDs with individual identifiers without breaking the mechanism of this method. Examples: ID "42" -> numeric id 42 ID "0foo" -> numeric id 0 ID "111.MyId.Something.Else" -> numeric id 111 ID "No Digits" -> not considered for numeric id The id returned will be 0 for an empty string table and it will be reset to 0 if all locales are removed. In all other cases this method returns the maximum numeric id used so far at the beginning of a Resource ID incremented by 1. When calling this method more than once always the same number will be returned until this number is really used at the beginning of a new Resource ID passed to <a href="#setString">setString</a> or <a href="#setStringForLocale">setStringForLocale</a>. As the numeric id is guaranteed to be unique for the complete string table all locales are taken into account. So using this methods will force the implementation to load all locale data that may not have been loaded so far. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="isReadOnly" class="membertitle">isReadOnly</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isReadOnly</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the resource's read only state </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the resource is read only, otherwise <b>false</b> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setCurrentLocale" class="membertitle">setCurrentLocale</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setCurrentLocale</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> FindClosestMatch )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Sets the locale to be used </dd> <dt><b>Parameter aLocale</b></dt> <dd>Specifies the current locale to be used. </dd> <dt><b>Parameter FindClosestMatch</b></dt> <dd><p>If true: If the exact locale that should be set is not available the method tries to find the closest match. E.g. if en_US is re- quired but not available, en would be the next choice. Finally the default locale will be used <b>true</b>. <p>If false: If the exact locale that should be set is not available a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> is thrown. <p>If false: If the exact locale that should be set is not available a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> is thrown. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setDefaultLocale" class="membertitle">setDefaultLocale</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setDefaultLocale</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Sets the default locale to be used </dd> <dt><b>Parameter aLocale</b></dt> <dd>Specifies the default locale to be used. If this locale is not available a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> is thrown. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> if the resource is read only, see <a href="#isReadOnly">isReadOnly</a> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setString" class="membertitle">setString</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setString</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> ResourceID,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> Str )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Associates a String to a Resource ID for the current locale. If an entry for the Resource ID already exists, the string associated with it will be overwritten, otherwise a new entry will be created. </dd> <dt><b>Parameter ResourceID</b></dt> <dd>ID to address the string inside the resource for the current locale. </dd> <dt><b>Parameter Str</b></dt> <dd>String to be associated with the Resource ID. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> if the resource is read only, see <a href="#isReadOnly">isReadOnly</a> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setStringForLocale" class="membertitle">setStringForLocale</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setStringForLocale</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> ResourceID,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> Str,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Associates a String to a Resource ID for a specific locale. If an entry for the Resource ID already exists, the string associated with it will be overwritten, otherwise a new entry will be created. 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. </dd> <dt><b>Parameter ResourceID</b></dt> <dd>ID to address the string inside the resource. </dd> <dt><b>Parameter Str</b></dt> <dd>String to be associated with the Resource ID. </dd> <dt><b>Parameter locale</b></dt> <dd>The locale the string should be set for. The locale has to match exactly with one of the locales provided by <a href="#getLocales">getLocales</a>. A closest match search is not supported. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> if the resource is read only, see <a href="#isReadOnly">isReadOnly</a> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeId" class="membertitle">removeId</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeId</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> ResourceID )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MissingResourceException.html">MissingResourceException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Removes a Resource ID including the corresponding string for the current locale. </dd> <dt><b>Parameter ResourceID</b></dt> <dd>The Resource ID to be removed for the current locale. </dd> <dt><b>Throws</b></dt> <dd><a href="MissingResourceException.html">MissingResourceException</a> if the Resource ID is not valid. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> if the resource is read only, see <a href="#isReadOnly">isReadOnly</a> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeIdForLocale" class="membertitle">removeIdForLocale</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeIdForLocale</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> ResourceID,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MissingResourceException.html">MissingResourceException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Removes a Resource ID including the corresponding string for s specific locale. </dd> <dt><b>Parameter ResourceID</b></dt> <dd>The Resource ID to be removed. </dd> <dt><b>Parameter locale</b></dt> <dd>The locale the Resource ID should be removed for. The locale has to match exactly with one of the locales provided by <a href="#getLocales">getLocales</a>. A closest match search is not supported. </dd> <dt><b>Throws</b></dt> <dd><a href="MissingResourceException.html">MissingResourceException</a> if the Resource ID is not valid. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> if the resource is read only, see <a href="#isReadOnly">isReadOnly</a> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="newLocale" class="membertitle">newLocale</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>newLocale</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Creates a new locale. </dd> <dd><p>For each existing ResourceID an empty string will be created. The first locale created will automatically be the first default locale. Otherwise strings for all already created IDs will be copied from the default locale.</p> </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a> if the Locale already has been created. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> if the Locale is not valid. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> if the resource is read only, see <a href="#isReadOnly">isReadOnly</a> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeLocale" class="membertitle">removeLocale</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeLocale</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Removes a locale completely including the corresponding strings for each locale. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> if the Locale to be removed is not supported. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> if the resource is read only, see <a href="#isReadOnly">isReadOnly</a> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getUniqueNumericId" class="membertitle">getUniqueNumericId</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getUniqueNumericId</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Provides a numeric id that is unique within all Resource IDs used in the string table. This method takes into account all Resource IDs starting with a decimal number and only evaluates the ID until the first non digit character is reached. This allows to extend unique IDs with individual identifiers without breaking the mechanism of this method. Examples: ID "42" -> numeric id 42 ID "0foo" -> numeric id 0 ID "111.MyId.Something.Else" -> numeric id 111 ID "No Digits" -> not considered for numeric id The id returned will be 0 for an empty string table and it will be reset to 0 if all locales are removed. In all other cases this method returns the maximum numeric id used so far at the beginning of a Resource ID incremented by 1. When calling this method more than once always the same number will be returned until this number is really used at the beginning of a new Resource ID passed to <a href="#setString">setString</a> or <a href="#setStringForLocale">setStringForLocale</a>. As the numeric id is guaranteed to be unique for the complete string table all locales are taken into account. So using this methods will force the implementation to load all locale data that may not have been loaded so far. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/NoSupportException.html">NoSupportException</a> 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 this methods should be used. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
4753
