summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/XContent.idl
blob: 61dd657995c5a42d5ec51f498bbeb5dc12e01033 (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
/*************************************************************************
 *
 * 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: XContent.idl,v $
 * $Revision: 1.9 $
 *
 * 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_ucb_XContent_idl__
#define __com_sun_star_ucb_XContent_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_ucb_XContentIdentifier_idl__
#include <com/sun/star/ucb/XContentIdentifier.idl>
#endif

#ifndef __com_sun_star_ucb_XContentEventListener_idl__
#include <com/sun/star/ucb/XContentEventListener.idl>
#endif


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

module com { module sun { module star { module ucb {

//=============================================================================
/** specifies a content with a type and an identifier, which is able to manage
    listeners for events that are related to contents.

     @version  1.0
     @author   Kai Sommerfeld
     @see      XContentIdentifier
     @see      XContentEventListener
*/
published interface XContent: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** returns the identifier of the content.

        @returns
        the identifier.
    */
    com::sun::star::ucb::XContentIdentifier getIdentifier();

    //-------------------------------------------------------------------------
    /** returns a type string, which is unique for that type of content (e.g.
        "application/vnd.sun.star.hierarchy-folder").

        @returns
        the content type string.
    */
    string getContentType();

    //-------------------------------------------------------------------------
    /** adds a listener for content events.

        @param Listener
        the listener to add.

        @see ContentEvent
    */
    [oneway] void addContentEventListener(
                    [in] com::sun::star::ucb::XContentEventListener Listener );

    //-------------------------------------------------------------------------
    /** removes a listener for content events.

        @param Listener
        the listener to remove.

        @see ContentEvent
    */
    [oneway] void removeContentEventListener(
                    [in] com::sun::star::ucb::XContentEventListener Listener );

};

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

}; }; }; };

#endif