xref: /core/offapi/com/sun/star/style/NumberingType.idl (revision 62b5dd31ffdad49f36aef2b7f6f1c54bcbf320ec)
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
20
21
22 module com {  module sun {  module star {  module style {
23
24/** These constants are used to specify which numbering style is used.
25 */
26published constants NumberingType
27{
28    /** Numbering is put in upper case letters as "A, B, C, D, ...".
29     */
30    const short CHARS_UPPER_LETTER = 0;
31
32    /** Numbering is in lower case letters as "a, b, c, e,...".
33     */
34    const short CHARS_LOWER_LETTER = 1;
35
36    /** Numbering is in Roman numbers with upper case letters
37                as "I, II, III, IV, ...".
38     */
39    const short ROMAN_UPPER = 2;
40
41    /** Numbering is in Roman numbers with lower case letters
42                as "i, ii, iii, iv, ...".
43     */
44    const short ROMAN_LOWER = 3;
45
46    /** Numbering is in Arabic numbers as "1, 2, 3, 4, ...".
47     */
48    const short ARABIC = 4;
49
50    /** Numbering is invisible.
51     */
52    const short NUMBER_NONE = 5;
53
54    /** Use a character from a specified font.
55     */
56    const short CHAR_SPECIAL = 6;
57
58    /** Numbering is specified in the page style.
59     */
60    const short PAGE_DESCRIPTOR = 7;
61
62    /** Numbering is displayed as a bitmap graphic.
63     */
64    const short BITMAP = 8;
65
66    /** Numbering is put in upper case letters as "A, B, ..., Y, Z,
67        AA, BB, CC, ... AAA, ...".
68     */
69    const short CHARS_UPPER_LETTER_N = 9;
70
71    /** Numbering is put in lower case letters as "a, b, ..., y, z,
72        aa, bb, cc, ... aaa, ...".
73     */
74    const short CHARS_LOWER_LETTER_N =10;
75
76    /** A transliteration module will be used to produce numbers in
77        Chinese, Japanese, etc.
78     */
79
80    const short TRANSLITERATION = 11;
81
82    /** The NativeNumberSupplier service will be called to produce numbers in
83        native languages.
84     */
85    const short NATIVE_NUMBERING = 12;
86
87    /** Numbering for fullwidth Arabic number
88     */
89    const short FULLWIDTH_ARABIC = 13;
90
91    /** Bullet for Circle Number
92     */
93    const short CIRCLE_NUMBER = 14;
94
95    /** Numbering for Chinese lower case number
96        as "一,二,三..."
97     */
98    const short NUMBER_LOWER_ZH = 15;
99
100    /** Numbering for Chinese upper case number
101     */
102    const short NUMBER_UPPER_ZH = 16;
103
104    /** Numbering for Traditional Chinese upper case number
105     */
106    const short NUMBER_UPPER_ZH_TW = 17;
107
108    /** Bullet for Chinese Tian Gan
109        as "甲,乙,丙..."
110     */
111    const short TIAN_GAN_ZH = 18;
112
113    /** Bullet for Chinese Di Zi
114        as "子,丑,寅..."
115     */
116    const short DI_ZI_ZH = 19;
117
118    /** Numbering for Japanese traditional number
119     */
120    const short NUMBER_TRADITIONAL_JA = 20;
121
122    /** Bullet for Japanese AIU fullwidth
123     */
124    const short AIU_FULLWIDTH_JA = 21;
125
126    /** Bullet for Japanese AIU halfwidth
127     */
128    const short AIU_HALFWIDTH_JA = 22;
129
130    /** Bullet for Japanese IROHA fullwidth
131     */
132    const short IROHA_FULLWIDTH_JA = 23;
133
134    /** Bullet for Japanese IROHA halfwidth
135     */
136    const short IROHA_HALFWIDTH_JA = 24;
137
138    /** Numbering for Korean upper case number
139        as "壹,貳,參..."
140     */
141    const short NUMBER_UPPER_KO = 25;
142
143    /** Numbering for Korean Hangul number
144        as "일,이,삼..."
145     */
146    const short NUMBER_HANGUL_KO = 26;
147
148    /** Bullet for Korean Hangul Jamo
149        as "ㄱ,ㄴ,ㄷ..."
150     */
151    const short HANGUL_JAMO_KO = 27;
152
153    /** Bullet for Korean Hangul Syllable
154        as "가,나,다..."
155     */
156    const short HANGUL_SYLLABLE_KO = 28;
157
158    /** Bullet for Korean Hangul Circled Jamo
159        as "㉠,㉡,㉢..."
160     */
161    const short HANGUL_CIRCLED_JAMO_KO = 29;
162
163    /** Bullet for Korean Hangul Circled Syllable
164        as "㉮,㉯,㉰..."
165     */
166    const short HANGUL_CIRCLED_SYLLABLE_KO = 30;
167
168    /** Numbering in Arabic alphabet letters
169        as "أ,ب,ت..."
170
171        @since OOo 1.1.2
172     */
173    const short CHARS_ARABIC = 31;
174
175    /** Numbering in Thai alphabet letters
176
177        @since OOo 1.1.2
178     */
179    const short CHARS_THAI = 32;
180
181    /** Numbering in Hebrew alphabet letters
182
183        @since OOo 2.0
184     */
185    const short CHARS_HEBREW = 33;
186
187    /** Numbering in Nepali alphabet letters
188
189        @since OOo 2.0.1
190     */
191    const short CHARS_NEPALI = 34;
192
193    /** Numbering in Khmer alphabet letters
194
195        @since OOo 2.0.1
196     */
197    const short CHARS_KHMER = 35;
198
199    /** Numbering in Lao alphabet letters
200
201        @since OOo 2.0.1
202      */
203    const short CHARS_LAO = 36;
204    /** Numbering in Tibetan/Dzongkha alphabet letters
205
206        @since OOo 2.0.3
207      */
208    const short CHARS_TIBETAN = 37;
209
210    /** Numbering in Cyrillic alphabet upper case letters as
211        "А, Б,  В, Г, ..., Ю, Я, Ав, Аа, Ав, ... Ааа, Ааб".
212
213        @since OOo 2.0.4
214     */
215     /*
216        Since IDL comments allow only 7-bit characters, hence the XHTML
217        entities above for the generated documentation, for the
218        developer here the human readable Unicode descriptions:
219
220        CYRILLIC CAPITAL LETTER A , CYRILLIC CAPITAL LETTER BE ,
221            CYRILLIC CAPITAL LETTER VE , CYRILLIC CAPITAL LETTER GHE , ... ,
222            CYRILLIC CAPITAL LETTER YU , CYRILLIC CAPITAL LETTER YA ,
223        CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER A ,
224            CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER BE ,
225            CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER VE , ...
226        CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A ,
227            CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER BE
228      */
229    const short CHARS_CYRILLIC_UPPER_LETTER_BG = 38;
230
231    /** Numbering in Cyrillic alphabet lower case letters as
232        "а, б, в, г, ..., ю, я, а а,  аб, ав, ...  а а а,  а аб".
233
234        @since OOo 2.0.4
235     */
236     /*
237        CYRILLIC SMALL LETTER A , CYRILLIC SMALL LETTER BE ,
238            CYRILLIC SMALL LETTER VE , CYRILLIC SMALL LETTER GHE , ... ,
239            CYRILLIC SMALL LETTER YU , CYRILLIC SMALL LETTER YA ,
240        CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A ,
241            CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER BE ,
242            CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER VE , ...
243        CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A ,
244        CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER BE
245      */
246    const short CHARS_CYRILLIC_LOWER_LETTER_BG = 39;
247
248    /** Numbering in Cyrillic alphabet upper case letters as
249        "А, Б, ..., Ю, Я, Аа, Бб, Вв, ... Ааа, ...".
250
251        @since OOo 2.0.4
252     */
253     /*
254        CYRILLIC CAPITAL LETTER A , CYRILLIC CAPITAL LETTER BE , ... ,
255            CYRILLIC CAPITAL LETTER YU , CYRILLIC CAPITAL LETTER YA ,
256        CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER A ,
257            CYRILLIC CAPITAL LETTER BE CYRILLIC SMALL LETTER BE ,
258            CYRILLIC CAPITAL LETTER VE CYRILLIC SMALL LETTER VE , ...
259        CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A , ...
260      */
261    const short CHARS_CYRILLIC_UPPER_LETTER_N_BG = 40;
262
263    /** Numbering in Cyrillic alphabet upper case letters as
264        "а, б, ..., ю, я, аа, бб, вв, ... ааа, ...".
265
266        @since OOo 2.0.4
267     */
268     /*
269        CYRILLIC SMALL LETTER A , CYRILLIC SMALL LETTER BE , ... ,
270            CYRILLIC SMALL LETTER YU , CYRILLIC SMALL LETTER YA ,
271        CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A ,
272            CYRILLIC SMALL LETTER BE CYRILLIC SMALL LETTER BE ,
273            CYRILLIC SMALL LETTER VE CYRILLIC SMALL LETTER VE , ...
274        CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A , ...
275      */
276    const short CHARS_CYRILLIC_LOWER_LETTER_N_BG = 41;
277
278    /** Numbering in Russian Cyrillic alphabet upper case letters as
279        "А, Б, В, Г, ..., Ю, Я, Аа, Аб, Ав, ... Ааа, Ааб".
280
281        @since OOo 2.0.4
282     */
283     /*
284        CYRILLIC CAPITAL LETTER A , CYRILLIC CAPITAL LETTER BE ,
285            CYRILLIC CAPITAL LETTER VE , CYRILLIC CAPITAL LETTER GHE , ... ,
286            CYRILLIC CAPITAL LETTER YU , CYRILLIC CAPITAL LETTER YA ,
287        CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER A ,
288            CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER BE ,
289            CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER VE , ...
290        CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A ,
291            CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER BE
292      */
293    const short CHARS_CYRILLIC_UPPER_LETTER_RU = 42;
294
295    /** Numbering in Russian Cyrillic alphabet lower case letters as
296        "а, б, в, г, ..., ю, я, аа, аб, ав, ... ааа, ааб".
297
298        @since OOo 2.0.4
299     */
300     /*
301        CYRILLIC SMALL LETTER A , CYRILLIC SMALL LETTER BE ,
302            CYRILLIC SMALL LETTER VE , CYRILLIC SMALL LETTER GHE , ... ,
303            CYRILLIC SMALL LETTER YU , CYRILLIC SMALL LETTER YA ,
304        CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A ,
305            CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER BE ,
306            CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER VE , ...
307        CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A ,
308            CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER BE
309      */
310    const short CHARS_CYRILLIC_LOWER_LETTER_RU = 43;
311
312    /** Numbering in Russian Cyrillic alphabet upper case letters as
313        "А, Б, ..., Ю, Я, Аа, Бб, Вв, ... Ааа, ...".
314
315        @since OOo 2.0.4
316     */
317     /*
318        CYRILLIC CAPITAL LETTER A , CYRILLIC CAPITAL LETTER BE , ... ,
319            CYRILLIC CAPITAL LETTER YU , CYRILLIC CAPITAL LETTER YA ,
320        CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER A ,
321            CYRILLIC CAPITAL LETTER BE CYRILLIC SMALL LETTER BE ,
322            CYRILLIC CAPITAL LETTER VE CYRILLIC SMALL LETTER VE , ...
323        CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A , ...
324      */
325    const short CHARS_CYRILLIC_UPPER_LETTER_N_RU = 44;
326
327    /** Numbering in Russian Cyrillic alphabet upper case letters as
328        "а, б, ..., ю, я, аа, бб, вв, ... ааа, ...".
329
330        @since OOo 2.0.4
331     */
332     /*
333        CYRILLIC SMALL LETTER A , CYRILLIC SMALL LETTER BE , ... ,
334            CYRILLIC SMALL LETTER YU , CYRILLIC SMALL LETTER YA ,
335        CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A ,
336            CYRILLIC SMALL LETTER BE CYRILLIC SMALL LETTER BE ,
337            CYRILLIC SMALL LETTER VE CYRILLIC SMALL LETTER VE , ...
338        CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A , ...
339      */
340    const short CHARS_CYRILLIC_LOWER_LETTER_N_RU = 45;
341
342    /** Numbering in Persian alphabet letters (aa, be, pe, te, ...)
343
344        @since OOo 2.4
345     */
346    const short CHARS_PERSIAN = 46;
347
348    /** Numbering in Myanmar alphabet letters
349
350        @since OOo 3.1
351     */
352    const short CHARS_MYANMAR = 47;
353
354    /** Numbering in Serbian Cyrillic alphabet upper case letters
355
356        @since OOo 3.1
357     */
358     /*
359        CYRILLIC CAPITAL LETTER A , CYRILLIC CAPITAL LETTER BE ,
360            CYRILLIC CAPITAL LETTER VE , CYRILLIC CAPITAL LETTER GHE , ... ,
361        CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER A ,
362            CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER BE ,
363            CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER VE , ...
364        CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A ,
365            CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER BE
366      */
367    const short CHARS_CYRILLIC_UPPER_LETTER_SR = 48;
368
369    /** Numbering in Russian Serbian alphabet lower case letters
370
371        @since OOo 3.1
372     */
373     /*
374        CYRILLIC SMALL LETTER A , CYRILLIC SMALL LETTER BE ,
375            CYRILLIC SMALL LETTER VE , CYRILLIC SMALL LETTER GHE , ... ,
376        CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A ,
377            CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER BE ,
378            CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER VE , ...
379        CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A ,
380            CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER BE
381      */
382    const short CHARS_CYRILLIC_LOWER_LETTER_SR = 49;
383
384    /** Numbering in Serbian Cyrillic alphabet upper case letters
385
386        @since OOo 3.1
387     */
388     /*
389        CYRILLIC CAPITAL LETTER A , CYRILLIC CAPITAL LETTER BE , ... ,
390        CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER A ,
391            CYRILLIC CAPITAL LETTER BE CYRILLIC SMALL LETTER BE ,
392            CYRILLIC CAPITAL LETTER VE CYRILLIC SMALL LETTER VE , ...
393        CYRILLIC CAPITAL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A , ...
394      */
395    const short CHARS_CYRILLIC_UPPER_LETTER_N_SR = 50;
396
397    /** Numbering in Serbian Cyrillic alphabet upper case letters
398
399        @since OOo 3.1
400     */
401     /*
402        CYRILLIC SMALL LETTER A , CYRILLIC SMALL LETTER BE , ... ,
403        CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A ,
404            CYRILLIC SMALL LETTER BE CYRILLIC SMALL LETTER BE ,
405            CYRILLIC SMALL LETTER VE CYRILLIC SMALL LETTER VE , ...
406        CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A CYRILLIC SMALL LETTER A , ...
407      */
408    const short CHARS_CYRILLIC_LOWER_LETTER_N_SR = 51;
409
410    /** Numbering in Greek alphabet upper case letters
411
412        @since LibreOffice 3.3
413     */
414    const short CHARS_GREEK_UPPER_LETTER = 52;
415
416    /** Numbering in Greek alphabet lower case letters
417
418        @since LibreOffice 3.3
419     */
420    const short CHARS_GREEK_LOWER_LETTER = 53;
421
422
423    /** Numbering in Arabic alphabet using abjad sequence
424
425        @since LibreOffice 3.5
426     */
427    const short CHARS_ARABIC_ABJAD = 54;
428
429    /** Numbering in Persian words
430
431        @since LibreOffice 3.5
432     */
433    const short CHARS_PERSIAN_WORD = 55;
434
435    /** Numbering in Hebrew numerals
436
437        @since LibreOffice 5.4
438     */
439    const short NUMBER_HEBREW = 56;
440
441    /** Numbering in Arabic-Indic numerals
442
443        @since LibreOffice 6.1
444     */
445    const short NUMBER_ARABIC_INDIC = 57;
446
447    /** Numbering in East Arabic-Indic numerals
448
449        @since LibreOffice 6.1
450     */
451    const short NUMBER_EAST_ARABIC_INDIC = 58;
452
453    /** Numbering in Indic Devanagari numerals
454
455        @since LibreOffice 6.1
456     */
457    const short NUMBER_INDIC_DEVANAGARI = 59;
458
459    /** Numbering in ordinal numbers of the language
460        of the text node
461        for example, 1st, 2nd, 3rd... in English
462
463        @since LibreOffice 6.1
464     */
465    const short TEXT_NUMBER = 60;
466
467    /** Numbering in cardinal numbers of the language
468        of the text node
469        for example, One, Two, Three... in English
470
471        @since LibreOffice 6.1
472     */
473    const short TEXT_CARDINAL = 61;
474
475    /** Numbering in ordinal numbers of the language
476        of the text node
477        for example, First, Second, Third... in English
478
479        @since LibreOffice 6.1
480     */
481    const short TEXT_ORDINAL = 62;
482
483    /** Footnoting symbols according the University of Chicago style:
484          \*, ߤ, ߥ, &#00a7;, **, ߤߤ etc.
485
486        @since LibreOffice 6.4
487     */
488     /*
489        ASTERISK, DAGGER, DOUBLE DAGGER, SECTION SIGN,
490        ASTERISK ASTERISK, DAGGER DAGGER, etc.
491      */
492    const short SYMBOL_CHICAGO = 63;
493
494    /** Numbering is in Arabic numbers, padded with zero to have a length of at least two, as "01,
495        02, ..., 10, 11, ...".
496
497        @since LibreOffice 7.0
498     */
499    const short ARABIC_ZERO = 64;
500
501    /** Numbering is in Arabic numbers, padded with zero to have a length of at least three, as
502        "001, 002, ..., 100, 101, ...".
503
504        @since LibreOffice 7.0
505     */
506    const short ARABIC_ZERO3 = 65;
507
508    /** Numbering is in Arabic numbers, padded with zero to have a length of at least four, as
509        "0001, 0002, ..., 1000, 1001, ...".
510
511        @since LibreOffice 7.0
512     */
513    const short ARABIC_ZERO4 = 66;
514
515    /** Numbering is in Arabic numbers, padded with zero to have a length of at least five, as
516        "00001, 00002, ..., 10000, 10001, ...".
517
518        @since LibreOffice 7.0
519     */
520    const short ARABIC_ZERO5 = 67;
521
522    /** Numbering is in Szekely rovas (Old Hungarian) numerals
523
524        @since LibreOffice 7.1
525     */
526    const short SZEKELY_ROVAS = 68;
527
528    /** Numbering is in Korean Digital number as
529        "일,이,삼,...,일영,일영영, ..."
530
531        @since LibreOffice 7.3
532     */
533    const short NUMBER_DIGITAL_KO = 69;
534
535    /** Numbering is in Korean Digital Number, reserved "koreanDigital2", as
536        "一,二,三,...,一零,一零零, ..."
537
538        @since LibreOffice 7.3
539     */
540    const short NUMBER_DIGITAL2_KO = 70;
541
542    /** Numbering is in Korean Legal Number, reserved "koreanLegal", as
543        "하나,둘,셋,..."
544
545        @since LibreOffice 7.3
546     */
547    const short NUMBER_LEGAL_KO = 71;
548
549    /** Numbering in Cyrillic alphabet upper case letters
550
551        @since LibreOffice 7.6
552        See https://en.wikipedia.org/wiki/Ukrainian_alphabet
553      */
554    const short CHARS_CYRILLIC_UPPER_LETTER_UK = 72;
555
556    /** Numbering in Cyrillic alphabet lower case letters
557
558        @since LibreOffice 7.6
559        See https://en.wikipedia.org/wiki/Ukrainian_alphabet
560      */
561    const short CHARS_CYRILLIC_LOWER_LETTER_UK = 73;
562
563    /** Numbering in Cyrillic alphabet upper case letters
564
565        @since LibreOffice 7.6
566        See https://en.wikipedia.org/wiki/Ukrainian_alphabet
567      */
568    const short CHARS_CYRILLIC_UPPER_LETTER_N_UK = 74;
569
570    /** Numbering in Cyrillic alphabet upper case letters
571
572        @since LibreOffice 7.6
573        See https://en.wikipedia.org/wiki/Ukrainian_alphabet
574      */
575    const short CHARS_CYRILLIC_LOWER_LETTER_N_UK = 75;
576
577
578};
579
580
581}; }; }; };
582
583/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
584