:: com :: sun :: star :: i18n ::
|
interface XExtendedIndexEntrySupplier |
- Base Interfaces
XExtendedIndexEntrySupplier
┗ XIndexEntrySupplier
XIndexEntrySupplier |
- (referenced interface's summary:)
- supplies information on index entries to generate a "table of
alphabetical index" for a given locale.
|
|
- Description
- This interface provides information for creating "Table of Index"
It is derived from
XIndexEntrySupplier and
provides following additional functionalities.
- Provide supported language/locale list.
- Provide supported algorithm list.
- Provide phonetic entry support for CJK language.
- Provide method to compare index entry.
- Since
- OOo 1.1.2
- Developers Guide
- OfficeDev - Overview and Using the API - XExtendedIndexEntrySupplier
|
Methods' Details |
getLocaleList
sequence< ::com::sun::star::lang::Locale > |
getLocaleList(); |
- Description
- Returns locale list for which the IndexEntrySupplier provides service.
|
|
getAlgorithmList
sequence< string > |
getAlgorithmList( |
[in] ::com::sun::star::lang::Locale |
aLocale ); |
- Description
- Returns index algorithm list for specific locale
|
|
usePhoneticEntry
boolean |
usePhoneticEntry( |
[in] ::com::sun::star::lang::Locale |
aLocale ); |
- Description
- Checks if Phonetic Entry should be used for the locale.
|
|
getPhoneticCandidate
string |
getPhoneticCandidate( |
[in] string |
aIndexEntry, |
| [in] ::com::sun::star::lang::Locale |
aLocale ); |
- Description
- Returns phonetic candidate for index entry for the locale.
|
|
loadAlgorithm
boolean |
loadAlgorithm( |
[in] ::com::sun::star::lang::Locale |
aLocale, |
| [in] string |
aIndexAlgorithm, |
| [in] long |
nCollatorOptions ); |
- Description
- Loads index algorithm for the locale.
- Parameter aIndexAlgorithm
- Index algorithm to be loaded.
- Parameter nCollatorOptions
- Sorting option of CollatorOptions for
comparing index entries
- Returns
- true if algorithm successfully loaded,
false else.
|
|
getIndexKey
string |
getIndexKey( |
[in] string |
aIndexEntry, |
| [in] string |
aPhoneticEntry, |
| [in] ::com::sun::star::lang::Locale |
aLocale ); |
- Description
- Returns index key.
Note that loadAlgorithm should be called before calling
this function.
- Parameter aIndexEntry
- Index entry
- Parameter aPhoneticEntry
- Phonetic entry
- Parameter aLocale
- Language attribute for index and phonetic entry.
aLocale and the locale in loadAlgorithm may be different.
In the case they are different, phonetic entry will not
be used in the index key generation.
|
|
compareIndexEntry
short |
compareIndexEntry( |
[in] string |
aIndexEntry1, |
| [in] string |
aPhoneticEntry1, |
| [in] ::com::sun::star::lang::Locale |
aLocale1, |
| [in] string |
aIndexEntry2, |
| [in] string |
aPhoneticEntry2, |
| [in] ::com::sun::star::lang::Locale |
aLocale2 ); |
- Description
- Compares index entries
Note that loadAlgorithm should be called before calling
this function.
- Parameter aIndexEntry1
- Parameter aIndexEntry2
- Index entries to be compared
- Parameter aPhoneticEntry1
- Parameter aPhoneticEntry2
- Phonetic entries to be compared
- Parameter aLocale1
- Parameter aLocale2
- Language attribute for index and phonetic entry.
aLocale and the locale in loadAlgorithm may be different.
In the case they are different, phonetic entry will not
be used in the index key generation.
|
|
Top of Page
Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.
LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.
The Document Foundation acknowledges all community members, please find more info at our website.
Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.