offapi/com/sun/star/sheet/TableAutoFormat.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: TableAutoFormat.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
  31 #ifndef __com_sun_star_sheet_TableAutoFormat_idl__
  32 #define __com_sun_star_sheet_TableAutoFormat_idl__
  33
  34 #ifndef __com_sun_star_container_XIndexAccess_idl__
  35 #include <com/sun/star/container/XIndexAccess.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  39 #include <com/sun/star/container/XEnumerationAccess.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_container_XNamed_idl__
  43 #include <com/sun/star/container/XNamed.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_beans_XPropertySet_idl__
  47 #include <com/sun/star/beans/XPropertySet.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module sheet {
  53
  54 //=============================================================================
  55
  56 /** represents an AutoFormat, containing exactly 16 AutoFormat fields.
  57
  58     <p>Each of the 16 fields contain formatting properties for a table
  59     cell at a specific position in the AutoFormat range. The rows of the
  60     range are divided into a header row, a footer row and 2 data rows
  61     (repeated in turn between header and footer row). The columns are
  62     divided similar. This results in 16 different types of cells in the
  63     range. The AutoFormats are numbered row by row, then column by column.</p>
  64
  65     @see com::sun::star::sheet::TableAutoFormatField
  66  */
  67 published service TableAutoFormat
  68 {
  69     //-------------------------------------------------------------------------
  70
  71 //!     service com::sun::star::beans::PropertySet;
  72     /** provides access to the properties.
  73      */
  74     interface com::sun::star::beans::XPropertySet;
  75
  76     //=========================================================================
  77
  78     /** provides methods to access the AutoFormat fields via index.
  79
  80         @see com::sun::star::sheet::TableAutoFormatField
  81      */
  82     interface com::sun::star::container::XIndexAccess;
  83
  84     //-------------------------------------------------------------------------
  85
  86     /** creates an enumeration of all 16 AutoFormat fields.
  87
  88         @see com::sun::star::sheet::TableAutoFormatEnumeration
  89      */
  90     interface com::sun::star::container::XEnumerationAccess;
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** provides methods to access the name of the AutoFormat.
  95      */
  96     interface com::sun::star::container::XNamed;
  97
  98     //=========================================================================
  99
 100     /** specifies whether the font settings from the fields are used.
 101      */
 102     [property] boolean IncludeFont;
 103
 104     //-------------------------------------------------------------------------
 105
 106     /** specifies whether the justification settings from the fields
 107         are used.
 108      */
 109     [property] boolean IncludeJustify;
 110
 111     //-------------------------------------------------------------------------
 112
 113     /** specifies whether the border settings from the fields are used.
 114      */
 115     [property] boolean IncludeBorder;
 116
 117     //-------------------------------------------------------------------------
 118
 119     /** specifies whether the background settings from the fields are used.
 120      */
 121     [property] boolean IncludeBackground;
 122
 123     //-------------------------------------------------------------------------
 124
 125     /** specifies whether the number format settings from the fields
 126         are used.
 127      */
 128     [property] boolean IncludeNumberFormat;
 129
 130     //-------------------------------------------------------------------------
 131
 132     /** specifies whether the column widths and row heights should be
 133         updated after applying the format.
 134      */
 135     [property] boolean IncludeWidthAndHeight;
 136
 137 };
 138
 139 //=============================================================================
 140
 141 }; }; }; };
 142
 143 #endif
 144