Version 6.4.0.0.beta1, tag libreoffice-6.4.0.0.beta1
[LibreOffice.git] / i18npool / inc / indexentrysupplier.hxx
blob5b711ea7684d130b160ab9391cdf9b4a8741b9f6
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
19 #ifndef INCLUDED_I18NPOOL_INC_INDEXENTRYSUPPLIER_HXX
20 #define INCLUDED_I18NPOOL_INC_INDEXENTRYSUPPLIER_HXX
22 #include <com/sun/star/i18n/XExtendedIndexEntrySupplier.hpp>
23 #include <cppuhelper/implbase.hxx>
24 #include <com/sun/star/lang/XServiceInfo.hpp>
26 namespace com::sun::star::uno { class XComponentContext; }
28 namespace i18npool {
31 // class IndexEntrySupplier
33 class IndexEntrySupplier final : public cppu::WeakImplHelper
35 css::i18n::XExtendedIndexEntrySupplier,
36 css::lang::XServiceInfo
39 public:
40 IndexEntrySupplier( const css::uno::Reference < css::uno::XComponentContext >& rxContext );
42 // Methods
43 virtual css::uno::Sequence < css::lang::Locale > SAL_CALL getLocaleList() override;
45 virtual css::uno::Sequence < OUString > SAL_CALL getAlgorithmList(
46 const css::lang::Locale& rLocale ) override;
48 virtual sal_Bool SAL_CALL loadAlgorithm(
49 const css::lang::Locale& rLocale,
50 const OUString& SortAlgorithm, sal_Int32 collatorOptions ) override;
52 virtual sal_Bool SAL_CALL usePhoneticEntry(
53 const css::lang::Locale& rLocale ) override;
55 virtual OUString SAL_CALL getPhoneticCandidate( const OUString& IndexEntry,
56 const css::lang::Locale& rLocale ) override;
58 virtual OUString SAL_CALL getIndexKey( const OUString& IndexEntry,
59 const OUString& PhoneticEntry, const css::lang::Locale& rLocale ) override;
61 virtual sal_Int16 SAL_CALL compareIndexEntry( const OUString& IndexEntry1,
62 const OUString& PhoneticEntry1, const css::lang::Locale& rLocale1,
63 const OUString& IndexEntry2, const OUString& PhoneticEntry2,
64 const css::lang::Locale& rLocale2 ) override;
66 virtual OUString SAL_CALL getIndexCharacter( const OUString& IndexEntry,
67 const css::lang::Locale& rLocale, const OUString& SortAlgorithm ) override;
69 virtual OUString SAL_CALL getIndexFollowPageWord( sal_Bool MorePages,
70 const css::lang::Locale& rLocale ) override;
72 //XServiceInfo
73 virtual OUString SAL_CALL getImplementationName() override;
74 virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
75 virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
77 private:
78 css::uno::Reference < css::i18n::XExtendedIndexEntrySupplier > xIES;
79 css::uno::Reference < css::uno::XComponentContext > m_xContext;
80 /// @throws css::uno::RuntimeException
81 bool createLocaleSpecificIndexEntrySupplier(const OUString& name);
82 /// @throws css::uno::RuntimeException
83 css::uno::Reference < css::i18n::XExtendedIndexEntrySupplier > const & getLocaleSpecificIndexEntrySupplier(
84 const css::lang::Locale& rLocale, const OUString& rSortAlgorithm);
86 css::lang::Locale aLocale;
87 OUString aSortAlgorithm;
92 #endif
94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */