Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: i18n ::
interface XCollator
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XCollator
Description Interface for collation algorithms used in sorting. Developers Guide 6.2.2 Office Development - Common Application Features - Internationalization - Overview and Using the API - XCollator 6.2.2 Office Development - Common Application Features - Internationalization - Implementing a New Locale - XCollator

Methods' Summary
compareSubstring | Compare 2 substrings.
compareString | Compare 2 strings.
loadDefaultCollator | Load the default collator.
loadCollatorAlgorithm | Load a particular collator algorithm.
listCollatorAlgorithms | List all collator algorithms for a given locale.
loadCollatorAlgorithmWithEndUserOption | Load a collator algorithm with options chosen by end user.
listCollatorOptions | List all end user collator options for a given algorithm.

Methods' Details
compareSubstring
long compareSubstring( | [in] string [in] long [in] long [in] string [in] long [in] long | aStr1, nOff1, nLen1, aStr2, nOff2, nLen2 );
Description Compare 2 substrings. Parameter aStr1 First string. Parameter nOff1 Offset (from 0) of the first substring. Parameter nLen1 Length (from offset) of the first substring. Parameter aStr2 Second string Parameter nOff2 Offset (from 0) of the second substring. Parameter nLen2 Length (from offset) of the second substring. Returns 1 if the first string is greater than the second string 0 if the first string is equal to the second string -1 if the first string is less than the second string
compareString
long compareString( | [in] string [in] string | aStr1, aStr2 );
Description Compare 2 strings. Parameter aStr1 First string. Parameter aStr2 Second string. Returns 1 if the first string is greater than the second string 0 if the first string is equal to the second string -1 if the first string is less than the second string
loadDefaultCollator
long loadDefaultCollator( | [in] ::com::sun::star::lang::Locale [in] long | aLocale, nCollatorOptions );
Description Load the default collator. Parameter aLocale The locale for this collator. Parameter nCollatorOptions A mask of CollatorOptions . Returns TODO
loadCollatorAlgorithm
long loadCollatorAlgorithm( | [in] string [in] ::com::sun::star::lang::Locale [in] long | aAlgorithmName, aLocale, nCollatorOptions );
Description Load a particular collator algorithm. Parameter aAlgorithmName Fhe algorithm to load. Parameter aLocale The locale for this collator. Parameter nCollatorOptions A mask of CollatorOptions . Returns TODO
listCollatorAlgorithms
sequence< string > listCollatorAlgorithms( | [in] ::com::sun::star::lang::Locale | aLocale );
Description List all collator algorithms for a given locale. Parameter aLocale The locale for which to list algorithms. Returns A sequence of algorithm names.
loadCollatorAlgorithmWithEndUserOption
void loadCollatorAlgorithmWithEndUserOption( | [in] string [in] ::com::sun::star::lang::Locale [in] sequence< long > | aAlgorithmName, aLocale, aCollatorOptions );
Description Load a collator algorithm with options chosen by end user. Parameter aAlgorithmName The algorithm name to load. Parameter aLocale The locale for this collator. Parameter aCollatorOptions A sequence of end user collator options like those returned by XCollator::listCollatorOptions() .
listCollatorOptions
sequence< long > listCollatorOptions( | [in] string | aAlgorithmName );
Description List all end user collator options for a given algorithm. Parameter aAlgorithmName The algorithm name for this collator. Returns An array of end user options available for the algorithm.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.