Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: i18n ::
interface XIndexEntrySupplier
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XIndexEntrySupplier
Description supplies information on index entries to generate a "table of alphabetical index" for a given locale. Developers Guide 6.2.2 Office Development - Common Application Features - Internationalization - Overview and Using the API - XIndexEntrySupplier 6.2.2 Office Development - Common Application Features - Internationalization - Implementing a New Locale - XIndexEntrySupplier

Methods' Summary
getIndexCharacter | returns the capital index key for sorting a table of indexes, to a given index entry, to a given ::com::sun::star::lang::Locale and to a given sort algorithm.
getIndexFollowPageWord | 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 ::com::sun::star::lang::Locale .

Methods' Details
getIndexCharacter
string getIndexCharacter( | [in] string [in] ::com::sun::star::lang::Locale [in] string | aIndexEntry, aLocale, aSortAlgorithm );
Description returns the capital index key for sorting a table of indexes, to a given index entry, to a given ::com::sun::star::lang::Locale and to a given sort algorithm. For example, in English locale it returns "K" for "keyboard"
getIndexFollowPageWord
string getIndexFollowPageWord( | [in] boolean [in] ::com::sun::star::lang::Locale | bMorePages, aLocale );
Description 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 ::com::sun::star::lang::Locale . For example, in English locale it returns "p." for bMorePages == false "pp." for bMorePages == true

Top of Page

Copyright © 2003 Sun Microsystems, Inc.