LibreOffice LibreOffice 25.8 SDK API Reference

XCollator.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20module com { module sun { module star { module i18n {
21
25published interface XCollator: com::sun::star::uno::XInterface
26{
52 long compareSubstring( [in] string aStr1, [in] long nOff1, [in] long nLen1,
53 [in] string aStr2, [in] long nOff2, [in] long nLen2 );
54
68 long compareString( [in] string aStr1, [in] string aStr2 );
69
84 long loadDefaultCollator( [in] ::com::sun::star::lang::Locale aLocale,
85 [in] long nCollatorOptions );
86
102 long loadCollatorAlgorithm( [in] string aAlgorithmName,
103 [in] ::com::sun::star::lang::Locale aLocale,
104 [in] long nCollatorOptions );
105
114 sequence <string> listCollatorAlgorithms(
115 [in] ::com::sun::star::lang::Locale aLocale );
116
129 void loadCollatorAlgorithmWithEndUserOption(
130 [in] string aAlgorithmName,
131 [in] ::com::sun::star::lang::Locale aLocale,
132 [in] sequence<long> aCollatorOptions );
133
142 sequence <long> listCollatorOptions( [in] string aAlgorithmName );
143
144};
145
146
147}; }; }; };
148
149
150/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::i18n::XCollator
provides locale-sensitive collation algorithms for string comparison.
Definition: XCollator.idl:26
com::sun::star::i18n::XCollator::listCollatorAlgorithms
sequence< string > listCollatorAlgorithms([in] ::com::sun::star::lang::Locale aLocale)
List all collator algorithms for a given locale.
com::sun::star::i18n::XCollator::loadCollatorAlgorithm
long loadCollatorAlgorithm([in] string aAlgorithmName, [in] ::com::sun::star::lang::Locale aLocale, [in] long nCollatorOptions)
Load a particular collator algorithm for the locale.
com::sun::star::i18n::XCollator::compareString
long compareString([in] string aStr1, [in] string aStr2)
Compare 2 strings in specific locale and algorithm.
com::sun::star::i18n::XCollator::loadCollatorAlgorithmWithEndUserOption
void loadCollatorAlgorithmWithEndUserOption([in] string aAlgorithmName, [in] ::com::sun::star::lang::Locale aLocale, [in] sequence< long > aCollatorOptions)
Load a collator algorithm with options chosen by end user.
com::sun::star::i18n::XCollator::compareSubstring
long compareSubstring([in] string aStr1, [in] long nOff1, [in] long nLen1, [in] string aStr2, [in] long nOff2, [in] long nLen2)
Compare 2 substrings in specific locale and algorithm.
com::sun::star::i18n::XCollator::listCollatorOptions
sequence< long > listCollatorOptions([in] string aAlgorithmName)
List all end user collator options for a given algorithm.
com::sun::star::i18n::XCollator::loadDefaultCollator
long loadDefaultCollator([in] ::com::sun::star::lang::Locale aLocale, [in] long nCollatorOptions)
Load the collator with default algorithm defined in locale data.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:34