Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.10

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: i18n ::

interface XIndexEntrySupplier
Description
supplies information on index entries to generate a "table of alphabetical index" for a given locale.
Developers Guide
OfficeDev - Overview and Using the API - XIndexEntrySupplier
OfficeDev - 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  aIndexEntry,
[in] ::com::sun::star::lang::Locale  aLocale,
[in] string  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  bMorePages,
[in] ::com::sun::star::lang::Locale  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

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.