Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

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

interface XIndexEntrySupplier

Base Interface
com::sun::star::uno::XInterface

Description
supplies information on index entries to generate a "table of alphabetical index", to a given locale information.

See also
Locale


Known Services which Export this Interface

com::sun::star::i18n::IndexEntrySupplier Supplier for creating index entries in a "table of alphabetical index"

Methods' Summary

getIndexCharacter returns the capital index key for sorting a table of indexes, to a given index entry, to a given Locale and to a given sort algorithm.
getIndexFollowPageWord returns the pagenumber word of an index entry, where one page or more pages are combined to one pagenumber entry, to a given Locale .

Methods' Details

getIndexCharacter
 
string
getIndexCharacter(
[ in ] string IndexEntry,
[ in ] com::sun::star::lang::Locale aLocale,
[ in ] string SortAlgorithm );

Description
returns the capital index key for sorting a table of indexes, to a given index entry, to a given Locale and to a given sort algorithm.

For example, in english locale it returns
"K" for "keyboard"

getIndexFollowPageWord
 
string
getIndexFollowPageWord(
[ in ] boolean MorePages,
[ in ] com::sun::star::lang::Locale aLocale );

Description
returns the pagenumber word of an index entry, where one page or more pages are combined to one pagenumber entry, to a given Locale .

For example, in english locale it returns
"p." for MorePages = false
"pp." for MorePages = true


Top of Page