LibreOffice
LibreOffice 6.4 SDK API Reference
XExtendedIndexEntrySupplier.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 #ifndef __com_sun_star_i18n_XExtendedIndexEntrySupplier_idl__
21 #define __com_sun_star_i18n_XExtendedIndexEntrySupplier_idl__
22 
25 
26 
27 module com { module sun { module star { module i18n {
28 
29 
30 
47 {
51  sequence < com::sun::star::lang::Locale > getLocaleList();
52 
56  sequence < string > getAlgorithmList(
57  [in] com::sun::star::lang::Locale aLocale );
58 
63 
67  string getPhoneticCandidate( [in] string aIndexEntry,
68  [in] com::sun::star::lang::Locale aLocale);
69 
88  [in] string aIndexAlgorithm,
89  [in] long nCollatorOptions );
90 
109  string getIndexKey( [in] string aIndexEntry, [in] string aPhoneticEntry,
110  [in] com::sun::star::lang::Locale aLocale );
111 
133  short compareIndexEntry( [in] string aIndexEntry1, [in] string aPhoneticEntry1,
134  [in] com::sun::star::lang::Locale aLocale1,
135  [in] string aIndexEntry2, [in] string aPhoneticEntry2,
136  [in] com::sun::star::lang::Locale aLocale2 );
137 };
138 
139 }; }; }; };
140 
141 #endif
142 
143 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XIndexEntrySupplier.idl
com::sun::star::i18n::XExtendedIndexEntrySupplier::getIndexKey
string getIndexKey([in] string aIndexEntry, [in] string aPhoneticEntry, [in] com::sun::star::lang::Locale aLocale)
Returns index key.
com::sun::star::i18n::XExtendedIndexEntrySupplier::getLocaleList
sequence< com::sun::star::lang::Locale > getLocaleList()
Returns locale list for which the IndexEntrySupplier provides service.
com::sun::star::i18n::XExtendedIndexEntrySupplier::getAlgorithmList
sequence< string > getAlgorithmList([in] com::sun::star::lang::Locale aLocale)
Returns index algorithm list for specific locale.
com::sun::star::i18n::XExtendedIndexEntrySupplier::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)
Compares index entries.
com::sun::star::i18n::XExtendedIndexEntrySupplier
This interface provides information for creating "Table of Index".
Definition: XExtendedIndexEntrySupplier.idl:47
com::sun::star::i18n::XExtendedIndexEntrySupplier::getPhoneticCandidate
string getPhoneticCandidate([in] string aIndexEntry, [in] com::sun::star::lang::Locale aLocale)
Returns phonetic candidate for index entry for the locale.
Locale.idl
com::sun::star::i18n::XExtendedIndexEntrySupplier::loadAlgorithm
boolean loadAlgorithm([in] com::sun::star::lang::Locale aLocale, [in] string aIndexAlgorithm, [in] long nCollatorOptions)
Loads index algorithm for the locale.
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:48
com
Definition: Ambiguous.idl:22
com::sun::star::i18n::XExtendedIndexEntrySupplier::usePhoneticEntry
boolean usePhoneticEntry([in] com::sun::star::lang::Locale aLocale)
Checks if Phonetic Entry should be used for the locale.
com::sun::star::i18n::XIndexEntrySupplier
supplies information on index entries to generate a "table of alphabetical index" for a given locale.
Definition: XIndexEntrySupplier.idl:34