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