| LibreOffice
    LibreOffice 24.8 SDK API Reference | 
supplies information on index entries to generate a "table of alphabetical index" for a given locale. More...
import "XIndexEntrySupplier.idl";
 
  
| Public Member Functions | |
| string | getIndexCharacter ([in] string aIndexEntry, [in] com::sun::star::lang::Locale aLocale, [in] string aSortAlgorithm) | 
| 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. | |
| string | getIndexFollowPageWord ([in] boolean bMorePages, [in] com::sun::star::lang::Locale aLocale) | 
| 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. | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) | 
| queries for a new interface to an existing UNO object. | |
| void | acquire () | 
| increases the reference counter by one. | |
| void | release () | 
| decreases the reference counter by one. | |
supplies information on index entries to generate a "table of alphabetical index" for a given locale.
| string getIndexCharacter | ( | [in] string | aIndexEntry, | 
| [in] com::sun::star::lang::Locale | aLocale, | ||
| [in] string | aSortAlgorithm ) | 
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"
| string getIndexFollowPageWord | ( | [in] boolean | bMorePages, | 
| [in] com::sun::star::lang::Locale | aLocale ) | 
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