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

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