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

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

interface XCollator

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

Description
Interface for Collator Objects


Known Services which Export this Interface

com::sun::star::i18n::ChapterCollator
com::sun::star::i18n::Collator

Methods' Summary

compareSubstring compares 2 sub-strings
compareString compares 2 strings
loadDefaultCollator loads the Default Collator Implementation
loadCollatorAlgorithm loads a particular Collator Algorithm
listCollatorAlgorithms list all collator Algorithms
loadCollatorAlgorithmWithEndUserOption loads Collator Algorithm with options chosen by end users
listCollatorOptions list all collator options

Methods' Details

compareSubstring
 
long
compareSubstring(
[ in ] string s1,
[ in ] long off1,
[ in ] long len1,
[ in ] string s2,
[ in ] long off2,
[ in ] long len2 );

Description
compares 2 sub-strings
Parameter s1
first String
Parameter off1
offset (from 0) of the first substring
Parameter len1
length (from offset) of the first substring
Parameter s2
second String
Parameter off2
offset (from 0) of the second substring
Parameter len2
length (from offset) of the second substring
Returns
1 if the first string is more than second string 0 if the first string is equals to second string -1 if the first string is less than second string
compareString
 
long
compareString(
[ in ] string s1,
[ in ] string s2 );

Description
compares 2 strings
Parameter s1
first String
Parameter s2
second String
Returns
1 if the first string is more than second string 0 if the first string is equals to second string -1 if the first string is less than second string
loadDefaultCollator
 
long
loadDefaultCollator(
[ in ] com::sun::star::lang::Locale rLocale,
[ in ] long collatorOptions );

Description
loads the Default Collator Implementation
Parameter rLocale
the locale for this Collator
Parameter collatorOptions
collator options
Returns
TODO
loadCollatorAlgorithm
 
long
loadCollatorAlgorithm(
[ in ] string impl,
[ in ] com::sun::star::lang::Locale rLocale,
[ in ] long collatorOptions );

Description
loads a particular Collator Algorithm
Parameter impl
the implementation name to load
Parameter rLocale
the locale for this Collator
Parameter collatorOptions
collator options
Returns
TODO
listCollatorAlgorithms
 
sequence< string >
listCollatorAlgorithms(
[ in ] com::sun::star::lang::Locale rLocale );

Description
list all collator Algorithms
Parameter rLocale
the locale for this Collator
Returns
an array of algorithms (string)
loadCollatorAlgorithmWithEndUserOption
 
void
loadCollatorAlgorithmWithEndUserOption(
[ in ] string impl,
[ in ] com::sun::star::lang::Locale rLocale,
[ in ] sequence< long > collatorOptions );

Description
loads Collator Algorithm with options chosen by end users
Parameter impl
the implementation name to load
Parameter rLocale
the locale for this Collator
Parameter collatorOptions
an array of collator options (long)
Returns
VOID
listCollatorOptions
 
sequence< long >
listCollatorOptions(
[ in ] string collatorAlgorithmName );

Description
list all collator options
Parameter collatorAlgorithmName
the algorithm name for this Collator
Returns
an array of options (long)

Top of Page