summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/i18n/XCollator.idl
blob: 666b815fd247517568ecdaa90b720cff961f7b50 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/*************************************************************************
 *
 *  $RCSfile: XCollator.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: jsc $ $Date: 2001-03-16 16:41:27 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_i18n_XCollator_idl__
#define __com_sun_star_i18n_XCollator_idl__

#include <com/sun/star/uno/Exception.idl>
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/Locale.idl>
#include <com/sun/star/i18n/XTransliteration.idl>
//=============================================================================

module com { module sun { module star { module i18n {

/* collator options */
constants CollatorOptions {
  const short CollatorOptions_IGNORE_CASE   = 1;
  const short CollatorOptions_IGNORE_KANA   = 2;
  const short CollatorOptions_IGNORE_WIDTH  = 4;
};


/** Interface for Collator Objects

*/
interface XCollator: com::sun::star::uno::XInterface
{
    /** compares 2 sub-strings

        @param s1
            first String

        @param off1
            offset (from 0) of the first substring

        @param len1
            length (from offset) of the first substring

        @param s2
            second String

        @param off2
            offset (from 0) of the second substring

        @param 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
    */
    long compareSubstring([in] string s1, [in] long off1, [in] long len1, [in] string s2, [in] long off2, [in] long len2);

    /** compares 2 strings

        @param s1
            first String

        @param 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
    */
    long compareString([in] string s1, [in] string s2);

    /** loads the Default Collator Implementation

        @param rLocale
            the locale for this Collator

                @param collatorOptions
                        collator options

        @returns
            TODO
    */
    long loadDefaultCollator([in] ::com::sun::star::lang::Locale rLocale,
                                 [in] long collatorOptions);

    /** loads a particular Collator Algorithm

        @param impl
            the implementation name to load

                @param rLocale
                        the locale for this Collator

                @param collatorOptions
                        collator options

        @returns
            TODO
    */
    long loadCollatorAlgorithm([in] string impl,
                                   [in] ::com::sun::star::lang::Locale rLocale,
                                   [in] long collatorOptions);

    /** list all collator Algorithms

        @param rLocale
            the locale for this Collator

        @returns
            an array of algorithms (string)
    */
    sequence <string> listCollatorAlgorithms([in] ::com::sun::star::lang::Locale rLocale);


        /** loads Collator Algorithm with options chosen by end users

                @param impl
                        the implementation name to load

                @param rLocale
                        the locale for this Collator

                @param collatorOptions
                        an array of collator options (long)

                @returns
                        VOID
        */
        void loadCollatorAlgorithmWithEndUserOption([in] string impl,
                                                    [in] ::com::sun::star::lang::Locale rLocale,
                                                    [in] sequence<long> collatorOptions);

        /** list all collator options

                @param collatorAlgorithmName
                        the algorithm name for this Collator

                @returns
                        an array of options (long)

        */
        sequence <long> listCollatorOptions([in] string collatorAlgorithmName);
};

//=============================================================================

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.3  2001/02/08 21:13:07  bustamam
    add collator options constants - Joe Xu

    Revision 1.1.1.1  2000/09/18 23:36:20  hjs
    initial import

    Revision 1.2  2000/09/12 22:09:21  gmu
    Change name of methods and put comments

    Revision 1.1  2000/09/08 01:21:10  gmu
    Change classname and method

    Revision 1.1  2000/08/23 19:32:52  gmu
    Add new IDL: XCollator.idl


=============================================================================*/
#endif