offapi/com/sun/star/i18n/XCollator.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XCollator.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_i18n_XCollator_idl__
  31 #define __com_sun_star_i18n_XCollator_idl__
  32
  33 #include <com/sun/star/uno/Exception.idl>
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #include <com/sun/star/lang/Locale.idl>
  36 //=============================================================================
  37
  38 module com { module sun { module star { module i18n {
  39
  40 /** provides locale-sensitive collation algorithms for string comparison.
  41
  42 */
  43 published interface XCollator: com::sun::star::uno::XInterface
  44 {
  45     //-------------------------------------------------------------------------
  46     /** Compare 2 substrings in specific locale and algorithm.
  47
  48         @param aStr1
  49             First string.
  50
  51         @param nOff1
  52             Offset (from 0) of the first string.
  53
  54         @param nLen1
  55             Length (from offset) of the first substring.
  56
  57         @param aStr2
  58             Second string
  59
  60         @param nOff2
  61             Offset (from 0) of the second string.
  62
  63         @param nLen2
  64             Length (from offset) of the second substring.
  65
  66         @returns
  67             1 if the first string is greater than the second string <br/>
  68             0 if the first string is equal to the second string <br/>
  69             -1 if the first string is less than the second string
  70     */
  71     long compareSubstring(  [in] string aStr1, [in] long nOff1, [in] long nLen1,
  72                             [in] string aStr2, [in] long nOff2, [in] long nLen2 );
  73
  74     //-------------------------------------------------------------------------
  75     /** Compare 2 strings in specific locale and algorithm.
  76
  77         @param aStr1
  78             First string.
  79
  80         @param aStr2
  81             Second string.
  82
  83         @returns
  84             1 if the first string is greater than the second string <br/>
  85             0 if the first string is equal to the second string <br/>
  86             -1 if the first string is less than the second string
  87     */
  88     long compareString( [in] string aStr1, [in] string aStr2 );
  89
  90     //-------------------------------------------------------------------------
  91     /** Load the collator with default algorithm defined in
  92         locale data.
  93
  94         @param aLocale
  95             The locale for this collator.
  96
  97         @param nCollatorOptions
  98             A mask of <type>CollatorOptions</type>.
  99
 100         @returns
 101             Returns 0 when loading was successful,
 102             otherwise throws runtime exception. In fact the return value
 103             should be ignored and the exception be caught instead.
 104     */
 105     long loadDefaultCollator(   [in] ::com::sun::star::lang::Locale aLocale,
 106                                 [in] long nCollatorOptions );
 107
 108     //-------------------------------------------------------------------------
 109     /** Load a particular collator algorithm for the locale.
 110
 111         @param aAlgorithmName
 112             The algorithm to load.
 113
 114         @param aLocale
 115             The locale for this collator.
 116
 117         @param nCollatorOptions
 118             A mask of <type>CollatorOptions</type>.
 119
 120         @returns
 121             Returns 0 when loading was successful,
 122             otherwise throws runtime exception.
 123     */
 124     long loadCollatorAlgorithm( [in] string aAlgorithmName,
 125                                 [in] ::com::sun::star::lang::Locale aLocale,
 126                                 [in] long nCollatorOptions );
 127
 128     //-------------------------------------------------------------------------
 129     /** List all collator algorithms for a given locale.
 130
 131         @param aLocale
 132             The locale for which to list algorithms.
 133
 134         @returns
 135             A sequence of algorithm names.
 136     */
 137     sequence <string> listCollatorAlgorithms(
 138                                 [in] ::com::sun::star::lang::Locale aLocale );
 139
 140     //-------------------------------------------------------------------------
 141     /** Load a collator algorithm with options chosen by end user.
 142
 143         @param aAlgorithmName
 144             The algorithm name to load.
 145
 146         @param aLocale
 147             The locale for this collator.
 148
 149         @param aCollatorOptions
 150             A sequence of end user collator options like those returned
 151             by <member>XCollator::listCollatorOptions()</member>.
 152     */
 153     void loadCollatorAlgorithmWithEndUserOption(
 154                                 [in] string aAlgorithmName,
 155                                 [in] ::com::sun::star::lang::Locale aLocale,
 156                                 [in] sequence<long> aCollatorOptions );
 157
 158     //-------------------------------------------------------------------------
 159     /** List all end user collator options for a given algorithm.
 160
 161         @param aAlgorithmName
 162             The algorithm name for this collator.
 163
 164         @returns
 165             An array of end user options available for the algorithm.
 166     */
 167     sequence <long> listCollatorOptions( [in] string aAlgorithmName );
 168
 169 };
 170
 171 //=============================================================================
 172
 173 }; }; }; };
 174
 175 //=============================================================================
 176
 177 #endif