summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/text/XNumberingFormatter.idl
blob: a44157922cfeea80fc9cd19a51c3bec847082f93 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_text_XNumberingFormatter_idl__
#define __com_sun_star_text_XNumberingFormatter_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/beans/PropertyValue.idl>
#include <com/sun/star/lang/Locale.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>

module com { module sun { module star { module text {
/**
    supports the formatting of numberings
    in various language environments.
    @see com::sun::star::text::NumberingRules
    @see com::sun::star::text::NumberingLevel
    @version    1.0
*/
published interface XNumberingFormatter : com::sun::star::uno::XInterface
{
/** @returns
    the formatted numbering string according to the given
    com::sun::star::text::NumberingLevel
    and the given com::sun::star::lang::Locale.
*/
    string makeNumberingString(
                [in]sequence <com::sun::star::beans::PropertyValue> aProperties,
                [in]com::sun::star::lang::Locale aLocale)
            raises( com::sun::star::lang::IllegalArgumentException );
};
};};};};
#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */