offapi/com/sun/star/text/XNumberingFormatter.idl

   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 module com { module sun { module star { module text {
  21 /**
  22     supports the formatting of numberings
  23     in various language environments.
  24     @see com::sun::star::text::NumberingRules
  25     @see com::sun::star::text::NumberingLevel
  26     @version    1.0
  27 */
  28 published interface XNumberingFormatter : com::sun::star::uno::XInterface
  29 {
  30 /** @returns
  31     the formatted numbering string according to the given
  32     com::sun::star::text::NumberingLevel
  33     and the given com::sun::star::lang::Locale.
  34 */
  35     string makeNumberingString(
  36                 [in]sequence <com::sun::star::beans::PropertyValue> aProperties,
  37                 [in]com::sun::star::lang::Locale aLocale)
  38             raises( com::sun::star::lang::IllegalArgumentException );
  39 };
  40 };};};};
  41
  42 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */