summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/Cell.idl
blob: 960b33df515a75dec3f4bc03ac4db6e93b15f07f (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_text_Cell_idl__
#define __com_sun_star_text_Cell_idl__

#include <com/sun/star/text/CellProperties.idl>
#include <com/sun/star/table/CellProperties.idl>
#include <com/sun/star/table/XCell.idl>
#include <com/sun/star/text/XText.idl>

//=============================================================================

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

//=============================================================================

/** represents a singe cell within a text table.

    @see com::sun::star::text::TextTable
 */
service Cell
{
    //-------------------------------------------------------------------------
    /** contains the properties of the text table cell.
       */
    service com::sun::star::text::CellProperties;

    //-------------------------------------------------------------------------
    /** contains properties from table cells.

        <p>All of these properties are either already available in the
        service
        <type scope="com::sun::star::text">CellProperties</type>, 
        or get matched against one of those or are implemented
        non-functional since they serve no purpose for text tables.</p>

        <p>The complete list is as follows:</p>
        <ul>
            <li>CellStyle: optional property, not implemented.</li>
            <li>CellBackColor: matched to "BackColor".</li>
            <li>IsCellBackgroundTransparent: matched to "BackTransparent".</li>
            <li>HoriJustify: non-functional implementation.</li>
            <li>VertJustify: non-functional implementation.</li>
            <li>IsTextWrapped: non-functional implementation.</li>
            <li>ParaIndent: non-functional implementation.</li>
            <li>Orientation: non-functional implementation.</li>
            <li>RotateAngle: non-functional implementation.</li>
            <li>RotateReference: non-functional implementation.</li>
            <li>AsianVerticalMode: optional property, not implemented.</li>
            <li>TableBorder: non-functional implementation.</li>
            <li>TopBorder: already available.</li>
            <li>BottomBorder: already available.</li>
            <li>LeftBorder: already available.</li>
            <li>RightBorder: already available.</li>
            <li>NumberFormat: already available.</li>
            <li>ShadowFormat: non-functional implementation.</li>
            <li>CellProtection: non-functional implementation.</li>
        </ul>

        @since OOo 2.0
     */
    service com::sun::star::table::CellProperties;

    //-------------------------------------------------------------------------

    /** provides access to the cell contents.
     */
    interface com::sun::star::table::XCell;

    //-------------------------------------------------------------------------

    /** provides access to formatted and unformatted text contents.
     */
    interface com::sun::star::text::XText;

};

//=============================================================================

}; }; }; };

#endif