summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/text/TextTableRow.idl
blob: dcecda3f25c75b11f8c7eac6fe6e150b17ba01f4 (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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/* -*- 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_text_TextTableRow_idl__
#define __com_sun_star_text_TextTableRow_idl__

#include <com/sun/star/beans/XPropertySet.idl>
#include <com/sun/star/util/Color.idl>
#include <com/sun/star/style/GraphicLocation.idl>
#include <com/sun/star/text/TableColumnSeparator.idl>
#include <com/sun/star/graphic/XGraphic.idl>

module com {  module sun {  module star {  module text {

/** specifies the properties of a text table row.

    @see com::sun::star::TextTable
 */
published service TextTableRow
{
    interface com::sun::star::beans::XPropertySet;


    /** specifies the color of the background.
     */
    [property] com::sun::star::util::Color BackColor;


    /** If `TRUE`, the background color value in "BackColor" is not visible.
     */
    [property] boolean BackTransparent;


    /** contains the URL of a background graphic.

        @deprecated as of LibreOffice 6.1 - use BackGraphic instead

        Note the new behaviour since it this was deprecated:
        This property can only be set and only external URLs are
        supported (no more vnd.sun.star.GraphicObject scheme). When an
        URL is set, then it will load the graphic and set the BackGraphic
        property.
     */
    [property] string BackGraphicURL;

    /** contains the name of the file filter of a background graphic.
     */
    [property] string BackGraphicFilter;


    /** determines the position of the background graphic.@see GraphicLocation
     */
    [property] com::sun::star::style::GraphicLocation BackGraphicLocation;


    /** contains the description of the columns in the table row.
     */
    [property] sequence< com::sun::star::text::TableColumnSeparator >   TableColumnSeparators;


    /** contains the height of the table row.
     */
    [property] long Height;


    /** If the value of this property is `TRUE`, the height of the table row
        depends on the content of the table cells.
     */
    [property] boolean IsAutoHeight;


        /** If `TRUE`, the row is allowed to be split at page or column breaks.

                @since OOo 2.0
         */
        [optional, property, maybevoid] boolean IsSplitAllowed;

    /** Grab bag of row properties, used as a string-any map for interop purposes.

        @since LibreOffice 4.4

        <p>This property is intentionally not handled by the ODF filter. Any
        member that should be handled there should be first moved out from this grab
        bag to a separate property.</p>
    */
    [optional, property] sequence<com::sun::star::beans::PropertyValue> RowInteropGrabBag;

    /** contains the graphic of the background.

        @since LibreOffice 6.1
     */
    [optional, property] com::sun::star::graphic::XGraphic BackGraphic;

    /** If TRUE, the table row wasn't deleted or inserted with its tracked cell content

        @since LibreOffice 7.2
     */

        [optional, property] boolean HasTextChangesOnly;

};


}; }; }; };


#endif

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