LibreOffice LibreOffice 25.2 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
21module com { module sun { module star { module i18n {
22
23
24
40published interface XExtendedIndexEntrySupplier : ::com::sun::star::i18n::XIndexEntrySupplier
41{
45 sequence < com::sun::star::lang::Locale > getLocaleList();
46
50 sequence < string > getAlgorithmList(
51 [in] com::sun::star::lang::Locale aLocale );
52
56 boolean usePhoneticEntry( [in] com::sun::star::lang::Locale aLocale);
57
61 string getPhoneticCandidate( [in] string aIndexEntry,
62 [in] com::sun::star::lang::Locale aLocale);
63
81 boolean loadAlgorithm( [in] com::sun::star::lang::Locale aLocale,
82 [in] string aIndexAlgorithm,
83 [in] long nCollatorOptions );
84
103 string getIndexKey( [in] string aIndexEntry, [in] string aPhoneticEntry,
104 [in] com::sun::star::lang::Locale aLocale );
105
127 short compareIndexEntry( [in] string aIndexEntry1, [in] string aPhoneticEntry1,
128 [in] com::sun::star::lang::Locale aLocale1,
129 [in] string aIndexEntry2, [in] string aPhoneticEntry2,
130 [in] com::sun::star::lang::Locale aLocale2 );
131};
132
133}; }; }; };
134
135/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::i18n::XExtendedIndexEntrySupplier
This interface provides information for creating "Table of Index".
Definition: XExtendedIndexEntrySupplier.idl:41
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.
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::getIndexKey
string getIndexKey([in] string aIndexEntry, [in] string aPhoneticEntry, [in] com::sun::star::lang::Locale aLocale)
Returns index key.
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::usePhoneticEntry
boolean usePhoneticEntry([in] com::sun::star::lang::Locale aLocale)
Checks if Phonetic Entry should be used for the locale.
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::i18n::XExtendedIndexEntrySupplier::getAlgorithmList
sequence< string > getAlgorithmList([in] com::sun::star::lang::Locale aLocale)
Returns index algorithm list for specific 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:30
com
Definition: Ambiguous.idl:20
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:34