summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/TableAutoFormat.idl
blob: 6eda428bcc56caaf25e90ee8b5dbbb9fea3e6626 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_sheet_TableAutoFormat_idl__
#define __com_sun_star_sheet_TableAutoFormat_idl__

#include <com/sun/star/container/XIndexAccess.idl>
#include <com/sun/star/container/XEnumerationAccess.idl>
#include <com/sun/star/container/XNamed.idl>
#include <com/sun/star/beans/XPropertySet.idl>


module com {  module sun {  module star {  module sheet {


/** represents an AutoFormat, containing exactly 16 AutoFormat fields.

    <p>Each of the 16 fields contain formatting properties for a table
    cell at a specific position in the AutoFormat range. The rows of the
    range are divided into a header row, a footer row and 2 data rows
    (repeated in turn between header and footer row). The columns are
    divided similar. This results in 16 different types of cells in the
    range. The AutoFormats are numbered row by row, then column by column.</p>

    @see com::sun::star::sheet::TableAutoFormatField
 */
published service TableAutoFormat
{

//! service com::sun::star::beans::PropertySet;
    /** provides access to the properties.
     */
    interface com::sun::star::beans::XPropertySet;


    /** provides methods to access the AutoFormat fields via index.

        @see com::sun::star::sheet::TableAutoFormatField
     */
    interface com::sun::star::container::XIndexAccess;


    /** creates an enumeration of all 16 AutoFormat fields.

        @see com::sun::star::sheet::TableAutoFormatEnumeration
     */
    interface com::sun::star::container::XEnumerationAccess;


    /** provides methods to access the name of the AutoFormat.
     */
    interface com::sun::star::container::XNamed;


    /** specifies whether the font settings from the fields are used.
     */
    [property] boolean IncludeFont;


    /** specifies whether the justification settings from the fields
        are used.
     */
    [property] boolean IncludeJustify;


    /** specifies whether the border settings from the fields are used.
     */
    [property] boolean IncludeBorder;


    /** specifies whether the background settings from the fields are used.
     */
    [property] boolean IncludeBackground;


    /** specifies whether the number format settings from the fields
        are used.
     */
    [property] boolean IncludeNumberFormat;


    /** specifies whether the column widths and row heights should be
        updated after applying the format.
     */
    [property] boolean IncludeWidthAndHeight;

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */