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

(Global Index)

Syntax

interface XCollator : com::sun::star::uno::XInterface ;

Description

Interface for Collator Objects

Method 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

Known Services Which Export this Interface

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

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

Method Details



compareSubstring

Syntax

long compareSubstring (
string s1,
long off1,
long len1,
string s2,
long off2,
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

Syntax

long compareString (
string s1,
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

Syntax

long loadDefaultCollator (
com::sun::star::lang::Locale rLocale,
long collatorOptions );

Description

loads the Default Collator Implementation

Parameter rLocale

the locale for this Collator

Parameter collatorOptions

collator options

Returns

TODO

loadCollatorAlgorithm

Syntax

long loadCollatorAlgorithm (
string impl,
com::sun::star::lang::Locale rLocale,
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

Syntax

sequence< string > listCollatorAlgorithms (
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

Syntax

void loadCollatorAlgorithmWithEndUserOption (
string impl,
com::sun::star::lang::Locale rLocale,
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

Syntax

sequence< long > listCollatorOptions (
string collatorAlgorithmName );

Description

list all collator options

Parameter collatorAlgorithmName

the algorithm name for this Collator

Returns

an array of options (long)
Top of Page