(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright & License
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.