offapi/com/sun/star/sheet/TableAutoFormat.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_TableAutoFormat_idl__
  21 #define __com_sun_star_sheet_TableAutoFormat_idl__
  22
  23 #include <com/sun/star/container/XIndexAccess.idl>
  24 #include <com/sun/star/container/XEnumerationAccess.idl>
  25 #include <com/sun/star/container/XNamed.idl>
  26 #include <com/sun/star/beans/XPropertySet.idl>
  27
  28
  29 module com {  module sun {  module star {  module sheet {
  30
  31
  32 /** represents an AutoFormat, containing exactly 16 AutoFormat fields.
  33
  34     <p>Each of the 16 fields contain formatting properties for a table
  35     cell at a specific position in the AutoFormat range. The rows of the
  36     range are divided into a header row, a footer row and 2 data rows
  37     (repeated in turn between header and footer row). The columns are
  38     divided similar. This results in 16 different types of cells in the
  39     range. The AutoFormats are numbered row by row, then column by column.</p>
  40
  41     @see com::sun::star::sheet::TableAutoFormatField
  42  */
  43 published service TableAutoFormat
  44 {
  45
  46 //! service com::sun::star::beans::PropertySet;
  47     /** provides access to the properties.
  48      */
  49     interface com::sun::star::beans::XPropertySet;
  50
  51
  52     /** provides methods to access the AutoFormat fields via index.
  53
  54         @see com::sun::star::sheet::TableAutoFormatField
  55      */
  56     interface com::sun::star::container::XIndexAccess;
  57
  58
  59     /** creates an enumeration of all 16 AutoFormat fields.
  60
  61         @see com::sun::star::sheet::TableAutoFormatEnumeration
  62      */
  63     interface com::sun::star::container::XEnumerationAccess;
  64
  65
  66     /** provides methods to access the name of the AutoFormat.
  67      */
  68     interface com::sun::star::container::XNamed;
  69
  70
  71     /** specifies whether the font settings from the fields are used.
  72      */
  73     [property] boolean IncludeFont;
  74
  75
  76     /** specifies whether the justification settings from the fields
  77         are used.
  78      */
  79     [property] boolean IncludeJustify;
  80
  81
  82     /** specifies whether the border settings from the fields are used.
  83      */
  84     [property] boolean IncludeBorder;
  85
  86
  87     /** specifies whether the background settings from the fields are used.
  88      */
  89     [property] boolean IncludeBackground;
  90
  91
  92     /** specifies whether the number format settings from the fields
  93         are used.
  94      */
  95     [property] boolean IncludeNumberFormat;
  96
  97
  98     /** specifies whether the column widths and row heights should be
  99         updated after applying the format.
 100      */
 101     [property] boolean IncludeWidthAndHeight;
 102
 103 };
 104
 105
 106 }; }; }; };
 107
 108 #endif
 109
 110 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */