offapi/com/sun/star/text/XDefaultNumberingProvider.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 #ifndef __com_sun_star_text_XDefaultNumberingProvider_idl__
  20 #define __com_sun_star_text_XDefaultNumberingProvider_idl__
  21
  22 #include <com/sun/star/container/XIndexAccess.idl>
  23 #include <com/sun/star/lang/Locale.idl>
  24 #include <com/sun/star/beans/PropertyValues.idl>
  25
  26 module com { module sun { module star { module text {
  27
  28 /**
  29     provides access to default <type scope="com::sun::star::text">NumberingRules</type>
  30      according to a given locale information.
  31     <p></p>
  32     @see <type scope="com::sun::star::text">NumberingRules</type>
  33     @see <type scope="com::sun::star::lang">Locale</type>
  34     @version    1.0
  35     @author     <a href="mailto:oliver.specht@germany.sun.com">Oliver Specht</a>
  36 */
  37 published interface XDefaultNumberingProvider : com::sun::star::uno::XInterface
  38 {
  39     /**
  40         provides access to outline numberings according to
  41         a given <type scope="com::sun::star::lang">Locale</type>.
  42         <p>Outline numberings usually consist of levels
  43             with different settings. </p>
  44         @see <type scope="com::sun::star::text">NumberingLevel</type>
  45     */
  46     sequence<com::sun::star::container::XIndexAccess>
  47         getDefaultOutlineNumberings([in]com::sun::star::lang::Locale aLocale);
  48     /**
  49         provides access to outline numberings according
  50         to a given <type scope="com::sun::star::lang">Locale</type>.
  51         <p>In contrast to outline numberings the continuous
  52             numberings consist of
  53             level using the equal settings in all numbering levels.</P>
  54         @see <type scope="com::sun::star::text">NumberingLevel</type>
  55         @see <type scope="com::sun::star::lang">Locale</type>
  56     */
  57     sequence<com::sun::star::beans::PropertyValues>
  58         getDefaultContinuousNumberingLevels([in]com::sun::star::lang::Locale aLocale);
  59 };
  60 };};};};
  61
  62 #endif
  63
  64
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */