offapi/com/sun/star/table/XAutoFormattable.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
  28 #ifndef __com_sun_star_table_XAutoFormattable_idl__
  29 #define __com_sun_star_table_XAutoFormattable_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  36 #include <com/sun/star/lang/IllegalArgumentException.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module table {
  42
  43 //=============================================================================
  44
  45 /** provides a method to apply TableAutoFormats to a cell range.
  46  */
  47 published interface XAutoFormattable: com::sun::star::uno::XInterface
  48 {
  49     //-------------------------------------------------------------------------
  50
  51     /** applies an AutoFormat to the cell range of the current context.
  52
  53         @param aName
  54             is the name of the AutoFormat to apply.
  55
  56         @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
  57             if the specified AutoFormat does not exist.
  58      */
  59     void autoFormat( [in] string aName )
  60             raises( com::sun::star::lang::IllegalArgumentException );
  61
  62 };
  63
  64 //=============================================================================
  65
  66 }; }; }; };
  67
  68 #endif
  69