interface XIndexEntrySupplier in module com::sun::star::i18n::

(Global Index)

Syntax

interface XIndexEntrySupplier : 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

Method 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 .

Known Services Which Export this Interface

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

Method Details



getIndexCharacter

Syntax

string getIndexCharacter (
string IndexEntry,
com::sun::star::lang::Locale aLocale,
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

Syntax

string getIndexFollowPageWord (
boolean MorePages,
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