xref: /AOO41X/main/offapi/com/sun/star/text/XNumberingTypeInfo.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_XNumberingTypeInfo_idl__
24#define __com_sun_star_text_XNumberingTypeInfo_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30module com { module sun { module star { module text {
31
32/** provides access to the numbering types that are supported by a component.
33    <p>To be able to store unknown numbering types in a file format the numbering types
34    correspond to an identifier.</p>
35    @see <type scope="com::sun::star::text">NumberingRules</type>
36    @see <type scope="com::sun::star::style">NumberingType</type>
37    @version    1.0
38    @author     <a href="mailto:oliver.specht@germany.sun.com">Oliver Specht</a>
39*/
40published interface XNumberingTypeInfo : com::sun::star::uno::XInterface
41{
42    /** returns the numbering type values that are supported by the component.
43        @see
44    */
45    sequence<short> getSupportedNumberingTypes();
46    /** returns the corresponding numbering type to an identifier.
47    */
48    short   getNumberingType([in]string NumberingIdentifier);
49    /** determins whether an identifier is supported.
50    */
51    boolean hasNumberingType([in]string NumberingIdentifier);
52    /** returns the corresponding identifiert to a numbering type.
53    */
54    string  getNumberingIdentifier([in]short NumberingType);
55};
56};};};};
57
58#endif
59
60