i18npool/inc/indexentrysupplier_common.hxx

   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 INCLUDED_I18NPOOL_INC_INDEXENTRYSUPPLIER_COMMON_HXX
  21 #define INCLUDED_I18NPOOL_INC_INDEXENTRYSUPPLIER_COMMON_HXX
  22
  23 #include <com/sun/star/i18n/XExtendedIndexEntrySupplier.hpp>
  24 #include <cppuhelper/implbase.hxx>
  25 #include <com/sun/star/lang/XServiceInfo.hpp>
  26 #include <rtl/ref.hxx>
  27
  28 namespace com::sun::star::uno { class XComponentContext; }
  29 namespace i18npool { class CollatorImpl; }
  30
  31 namespace i18npool {
  32
  33
  34
  35
  36 class IndexEntrySupplier_Common : public cppu::WeakImplHelper
  37 <
  38     css::i18n::XExtendedIndexEntrySupplier,
  39     css::lang::XServiceInfo
  40 >
  41 {
  42 public:
  43     IndexEntrySupplier_Common( const css::uno::Reference < css::uno::XComponentContext >& rxContext );
  44     virtual ~IndexEntrySupplier_Common() override;
  45
  46     virtual css::uno::Sequence < css::lang::Locale > SAL_CALL getLocaleList() override;
  47
  48     virtual css::uno::Sequence < OUString > SAL_CALL getAlgorithmList(
  49         const css::lang::Locale& rLocale ) override;
  50
  51     virtual sal_Bool SAL_CALL usePhoneticEntry(
  52         const css::lang::Locale& rLocale ) override;
  53
  54     virtual OUString SAL_CALL getPhoneticCandidate( const OUString& IndexEntry,
  55         const css::lang::Locale& rLocale ) override;
  56
  57     virtual sal_Bool SAL_CALL loadAlgorithm(
  58         const css::lang::Locale& rLocale,
  59         const OUString& SortAlgorithm, sal_Int32 collatorOptions ) override;
  60
  61     virtual OUString SAL_CALL getIndexKey( const OUString& IndexEntry,
  62         const OUString& PhoneticEntry, const css::lang::Locale& rLocale ) override;
  63
  64     virtual sal_Int16 SAL_CALL compareIndexEntry( const OUString& IndexEntry1,
  65         const OUString& PhoneticEntry1, const css::lang::Locale& rLocale1,
  66         const OUString& IndexEntry2, const OUString& PhoneticEntry2,
  67         const css::lang::Locale& rLocale2 ) override;
  68
  69     virtual OUString SAL_CALL getIndexCharacter( const OUString& rIndexEntry,
  70         const css::lang::Locale& rLocale, const OUString& rSortAlgorithm ) override;
  71
  72     virtual OUString SAL_CALL getIndexFollowPageWord( sal_Bool MorePages,
  73         const css::lang::Locale& rLocale ) override;
  74
  75     //XServiceInfo
  76     virtual OUString SAL_CALL getImplementationName() override;
  77     virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
  78     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
  79
  80 protected:
  81     const char *       implementationName;
  82     bool               usePhonetic;
  83     rtl::Reference<CollatorImpl>
  84                        collator;
  85     css::lang::Locale  aLocale;
  86     OUString           aAlgorithm;
  87
  88     /// @throws css::uno::RuntimeException
  89     const OUString& getEntry( const OUString& IndexEntry,
  90         const OUString& PhoneticEntry, const css::lang::Locale& rLocale );
  91 };
  92
  93 }
  94 #endif
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */