| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __com_sun_star_i18n_XIndexEntrySupplier_idl__ |
| #define __com_sun_star_i18n_XIndexEntrySupplier_idl__ |
| |
| #ifndef __com_sun_star_lang_Locale_idl__ |
| #include <com/sun/star/lang/Locale.idl> |
| #endif |
| |
| //============================================================================ |
| |
| module com { module sun { module star { module i18n { |
| |
| //============================================================================ |
| |
| /** |
| supplies information on index entries to generate a "table of |
| alphabetical index" for a given locale. |
| */ |
| |
| published interface XIndexEntrySupplier : com::sun::star::uno::XInterface |
| { |
| //------------------------------------------------------------------------ |
| /** |
| returns the capital index key for sorting a table of indexes, to |
| a given index entry, to a given <type |
| scope="com::sun::star::lang">Locale</type> and to a given sort |
| algorithm. |
| |
| <p> For example, in English locale it returns <b>"K"</b> for |
| "keyboard" |
| */ |
| string getIndexCharacter( [in] string aIndexEntry, [in] |
| com::sun::star::lang::Locale aLocale, [in] string aSortAlgorithm ); |
| |
| //------------------------------------------------------------------------ |
| /** |
| returns the page number word of an index entry, where one page |
| or more pages are combined to one page number entry, for a given |
| <type scope="com::sun::star::lang">Locale</type>. |
| |
| <p> For example, in English locale it returns <br/> |
| <b>"p."</b> for <em>bMorePages</em> == <FALSE/> <br/> |
| <b>"pp."</b> for <em>bMorePages</em> == <TRUE/> </p> |
| */ |
| string getIndexFollowPageWord( [in] boolean bMorePages, |
| [in] com::sun::star::lang::Locale aLocale ); |
| }; |
| |
| //============================================================================ |
| };};};}; |
| |
| #endif |
| |