summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/CellAnnotation.idl
blob: 7ebef93578cd51ab624d17ef46bff7d4ac76107d (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: CellAnnotation.idl,v $
 * $Revision: 1.8 $
 *
 * 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_sheet_CellAnnotation_idl__
#define __com_sun_star_sheet_CellAnnotation_idl__

#ifndef __com_sun_star_sheet_XSheetAnnotation_idl__
#include <com/sun/star/sheet/XSheetAnnotation.idl>
#endif

#ifndef __com_sun_star_sheet_XSheetAnnotationShapeSupplier_idl__
#include <com/sun/star/sheet/XSheetAnnotationShapeSupplier.idl>
#endif

#ifndef __com_sun_star_container_XChild_idl__
#include <com/sun/star/container/XChild.idl>
#endif

#ifndef __com_sun_star_text_XSimpleText_idl__
#include <com/sun/star/text/XSimpleText.idl>
#endif

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

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

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

/** represents a cell annotation object attached to a spreadsheet cell.

    @see com::sun::star::sheet::SheetCell
 */
published service CellAnnotation
{
    //-------------------------------------------------------------------------

    /** provides methods to query data of the annotation
        and to show and hide it.
     */
    interface com::sun::star::sheet::XSheetAnnotation;

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

    /** provides access to the parent of this object.

        <p>The parent of a cell annotation is the cell that contains it.</p>
     */
    interface com::sun::star::container::XChild;

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

    /** provides access to the text contents of the annotation.
     */
    interface com::sun::star::text::XSimpleText;

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

    [optional] interface com::sun::star::sheet::XSheetAnnotationShapeSupplier;

};

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

}; }; }; };

#endif