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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_XDefaultNumberingProvider_idl__
  28 #define __com_sun_star_text_XDefaultNumberingProvider_idl__
  29
  30 #ifndef __com_sun_star_container_XIndexAccess_idl__
  31 #include <com/sun/star/container/XIndexAccess.idl>
  32 #endif
  33 #ifndef __com_sun_star_lang_Locale_idl__
  34 #include <com/sun/star/lang/Locale.idl>
  35 #endif
  36 #ifndef __com_sun_star_beans_PropertyValues_idl__
  37 #include <com/sun/star/beans/PropertyValues.idl>
  38 #endif
  39
  40 module com { module sun { module star { module text {
  41
  42 /**
  43     provides access to default <type scope="com::sun::star::text">NumberingRules</type>
  44      according to a given locale information.
  45     <p></p>
  46     @see <type scope="com::sun::star::text">NumberingRules</type>
  47     @see <type scope="com::sun::star::lang">Locale</type>
  48     @version    1.0
  49     @author     <a href="mailto:oliver.specht@germany.sun.com">Oliver Specht</a>
  50 */
  51 published interface XDefaultNumberingProvider : com::sun::star::uno::XInterface
  52 {
  53     /**
  54         provides access to outline numberings according to
  55         a given <type scope="com::sun::star::lang">Locale</type>.
  56         <p>Outline numberings usually consist of levels
  57             with different settings. </p>
  58         @see <type scope="com::sun::star::text">NumberingLevel</type>
  59     */
  60     sequence<com::sun::star::container::XIndexAccess>
  61         getDefaultOutlineNumberings([in]com::sun::star::lang::Locale aLocale);
  62     /**
  63         provides access to outline numberings according
  64         to a given <type scope="com::sun::star::lang">Locale</type>.
  65         <p>In contrast to outline numberings the continuous
  66             numberings consist of
  67             level using the equal settings in all numbering levels.</P>
  68         @see <type scope="com::sun::star::text">NumberingLevel</type>
  69         @see <type scope="com::sun::star::lang">Locale</type>
  70     */
  71     sequence<com::sun::star::beans::PropertyValues>
  72         getDefaultContinuousNumberingLevels([in]com::sun::star::lang::Locale aLocale);
  73 };
  74 };};};};
  75
  76 #endif
  77
  78
  79